@github/copilot-sdk 1.0.8 → 1.0.9-preview.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -1
- package/dist/cjs/client.js +9 -0
- package/dist/cjs/extension.js +21 -6
- package/dist/cjs/factory.js +123 -0
- package/dist/cjs/generated/rpc.js +376 -11
- package/dist/cjs/index.js +11 -2
- package/dist/cjs/session.js +598 -3
- package/dist/cjs/sessionFsProvider.js +43 -0
- package/dist/cjs/types.js +3 -0
- package/dist/client.d.ts +1 -0
- package/dist/client.js +9 -0
- package/dist/extension.d.ts +11 -2
- package/dist/extension.js +22 -6
- package/dist/factory.d.ts +273 -0
- package/dist/factory.js +96 -0
- package/dist/generated/rpc.d.ts +2445 -228
- package/dist/generated/rpc.js +376 -11
- package/dist/generated/session-events.d.ts +260 -6
- package/dist/index.d.ts +4 -2
- package/dist/index.js +7 -1
- package/dist/session.d.ts +21 -0
- package/dist/session.js +602 -3
- package/dist/sessionFsProvider.d.ts +38 -2
- package/dist/sessionFsProvider.js +42 -0
- package/dist/types.d.ts +95 -10
- package/dist/types.js +2 -0
- package/docs/extensions.md +1 -0
- package/docs/factories.md +240 -0
- package/docs/factory-patterns.md +194 -0
- package/package.json +2 -2
package/dist/generated/rpc.d.ts
CHANGED
|
@@ -58,6 +58,25 @@ export type AgentInfoSource =
|
|
|
58
58
|
| "plugin"
|
|
59
59
|
/** Agent built into the Copilot runtime. */
|
|
60
60
|
| "builtin";
|
|
61
|
+
/**
|
|
62
|
+
* Controls whether built-in agents and authored prompt text are included.
|
|
63
|
+
*
|
|
64
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
65
|
+
* via the `definition` "AgentListRequest".
|
|
66
|
+
*/
|
|
67
|
+
/** @experimental */
|
|
68
|
+
export type AgentListRequest = {
|
|
69
|
+
[k: string]: unknown | undefined;
|
|
70
|
+
} | {
|
|
71
|
+
/**
|
|
72
|
+
* 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.
|
|
73
|
+
*/
|
|
74
|
+
includeBuiltInAgents?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* 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.
|
|
77
|
+
*/
|
|
78
|
+
includePrompt?: boolean;
|
|
79
|
+
};
|
|
61
80
|
/**
|
|
62
81
|
* Process kind tag for the registry entry
|
|
63
82
|
*
|
|
@@ -246,6 +265,29 @@ export type SlashCommandKind =
|
|
|
246
265
|
*/
|
|
247
266
|
/** @experimental */
|
|
248
267
|
export type SlashCommandInputCompletion = "directory";
|
|
268
|
+
/**
|
|
269
|
+
* Optional filters controlling which command sources to include in the listing.
|
|
270
|
+
*
|
|
271
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
272
|
+
* via the `definition` "CommandsListRequest".
|
|
273
|
+
*/
|
|
274
|
+
/** @experimental */
|
|
275
|
+
export type CommandsListRequest = {
|
|
276
|
+
[k: string]: unknown | undefined;
|
|
277
|
+
} | {
|
|
278
|
+
/**
|
|
279
|
+
* Include runtime built-in commands
|
|
280
|
+
*/
|
|
281
|
+
includeBuiltins?: boolean;
|
|
282
|
+
/**
|
|
283
|
+
* Include enabled user-invocable skills and commands
|
|
284
|
+
*/
|
|
285
|
+
includeSkills?: boolean;
|
|
286
|
+
/**
|
|
287
|
+
* Include commands registered by protocol clients, including SDK clients and extensions
|
|
288
|
+
*/
|
|
289
|
+
includeClientCommands?: boolean;
|
|
290
|
+
};
|
|
249
291
|
/**
|
|
250
292
|
* Result of the queued command execution.
|
|
251
293
|
*
|
|
@@ -485,17 +527,53 @@ export type ExternalToolTextResultForLlmContentResourceLinkIconTheme =
|
|
|
485
527
|
/** @experimental */
|
|
486
528
|
export type ExternalToolTextResultForLlmContentResourceDetails = EmbeddedTextResourceContents | EmbeddedBlobResourceContents;
|
|
487
529
|
/**
|
|
488
|
-
*
|
|
530
|
+
* Execution-critical factory storage operation.
|
|
531
|
+
*
|
|
532
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
533
|
+
* via the `definition` "FactoryDurableOperation".
|
|
534
|
+
*/
|
|
535
|
+
/** @experimental */
|
|
536
|
+
export type FactoryDurableOperation =
|
|
537
|
+
/** Creating the durable run and declared phases. */
|
|
538
|
+
"createRun"
|
|
539
|
+
/** Persisting the transition to running. */
|
|
540
|
+
| "markRunStarted"
|
|
541
|
+
/** Persisting the terminal run envelope. */
|
|
542
|
+
| "finishRun"
|
|
543
|
+
/** Persisting subagent admission accounting. */
|
|
544
|
+
| "reserveAgent"
|
|
545
|
+
/** Rolling back an uncommitted subagent admission. */
|
|
546
|
+
| "releaseAgent"
|
|
547
|
+
/** Persisting an idempotent model-usage charge. */
|
|
548
|
+
| "chargeCredit"
|
|
549
|
+
/** Persisting active execution time. */
|
|
550
|
+
| "addElapsed"
|
|
551
|
+
/** Reading the authoritative AI-credit total. */
|
|
552
|
+
| "reconcileCreditTotal"
|
|
553
|
+
/** Reading a journal entry without treating storage failure as a cache miss. */
|
|
554
|
+
| "journalGet"
|
|
555
|
+
/** Persisting a journal entry before reporting success. */
|
|
556
|
+
| "journalPut";
|
|
557
|
+
/**
|
|
558
|
+
* Current or terminal state of a factory run.
|
|
489
559
|
*
|
|
490
560
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
491
|
-
* via the `definition` "
|
|
561
|
+
* via the `definition` "FactoryRunStatus".
|
|
492
562
|
*/
|
|
493
563
|
/** @experimental */
|
|
494
|
-
export type
|
|
495
|
-
/**
|
|
496
|
-
"
|
|
497
|
-
/**
|
|
498
|
-
| "
|
|
564
|
+
export type FactoryRunStatus =
|
|
565
|
+
/** The run was minted and is awaiting approval. */
|
|
566
|
+
"pending"
|
|
567
|
+
/** The run is executing. */
|
|
568
|
+
| "running"
|
|
569
|
+
/** The run completed successfully. */
|
|
570
|
+
| "completed"
|
|
571
|
+
/** The run was interrupted while resource budget remained. */
|
|
572
|
+
| "halted"
|
|
573
|
+
/** The run was cancelled before completion. */
|
|
574
|
+
| "cancelled"
|
|
575
|
+
/** The factory body failed or reached a cumulative resource ceiling. */
|
|
576
|
+
| "error";
|
|
499
577
|
/**
|
|
500
578
|
* Machine-readable factory run failure.
|
|
501
579
|
*
|
|
@@ -524,6 +602,17 @@ export type FactoryRunFailure = {
|
|
|
524
602
|
*/
|
|
525
603
|
reason: string;
|
|
526
604
|
type: "factory_resume_declined";
|
|
605
|
+
} | {
|
|
606
|
+
/**
|
|
607
|
+
* Stable failure code.
|
|
608
|
+
*/
|
|
609
|
+
code: string;
|
|
610
|
+
operation: FactoryDurableOperation;
|
|
611
|
+
/**
|
|
612
|
+
* Factory run identifier.
|
|
613
|
+
*/
|
|
614
|
+
runId: string;
|
|
615
|
+
type: "factory_durable_failure";
|
|
527
616
|
};
|
|
528
617
|
/**
|
|
529
618
|
* Cumulative resource ceiling that stopped a factory run.
|
|
@@ -535,28 +624,38 @@ export type FactoryRunFailure = {
|
|
|
535
624
|
export type FactoryRunFailureKind =
|
|
536
625
|
/** The run admitted the approved maximum total number of subagents. */
|
|
537
626
|
"maxTotalSubagents"
|
|
538
|
-
/** The run reached the approved
|
|
539
|
-
| "
|
|
627
|
+
/** The run reached the approved accumulated active-execution time in seconds. */
|
|
628
|
+
| "timeoutSeconds"
|
|
629
|
+
/** The run's settled subagent model usage exceeded the approved AI-credit ceiling, or no headroom remained for another subagent. */
|
|
630
|
+
| "maxAiCredits";
|
|
540
631
|
/**
|
|
541
|
-
*
|
|
632
|
+
* Kind of factory progress line.
|
|
542
633
|
*
|
|
543
634
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
544
|
-
* via the `definition` "
|
|
635
|
+
* via the `definition` "FactoryLogLineKind".
|
|
545
636
|
*/
|
|
546
637
|
/** @experimental */
|
|
547
|
-
export type
|
|
548
|
-
/**
|
|
638
|
+
export type FactoryLogLineKind =
|
|
639
|
+
/** A narrator log line. */
|
|
640
|
+
"log"
|
|
641
|
+
/** A named factory phase marker. */
|
|
642
|
+
| "phase";
|
|
643
|
+
/**
|
|
644
|
+
* Derived lifecycle state of a factory phase.
|
|
645
|
+
*
|
|
646
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
647
|
+
* via the `definition` "FactoryPhaseStatus".
|
|
648
|
+
*/
|
|
649
|
+
/** @experimental */
|
|
650
|
+
export type FactoryPhaseStatus =
|
|
651
|
+
/** The phase has not been entered yet. */
|
|
549
652
|
"pending"
|
|
550
|
-
/** The
|
|
551
|
-
| "
|
|
552
|
-
/** The
|
|
653
|
+
/** The phase is currently entered and accumulating active time. */
|
|
654
|
+
| "active"
|
|
655
|
+
/** The phase was entered and has since been closed. */
|
|
553
656
|
| "completed"
|
|
554
|
-
/** The
|
|
555
|
-
| "
|
|
556
|
-
/** The run was cancelled before completion. */
|
|
557
|
-
| "cancelled"
|
|
558
|
-
/** The factory body failed or reached a cumulative resource ceiling. */
|
|
559
|
-
| "error";
|
|
657
|
+
/** The phase was never entered because a later phase was entered or the run reached a terminal state. */
|
|
658
|
+
| "skipped";
|
|
560
659
|
/**
|
|
561
660
|
* Content filtering mode to apply to all tools, or a map of tool name to content filtering mode.
|
|
562
661
|
*
|
|
@@ -567,6 +666,109 @@ export type FactoryRunStatus =
|
|
|
567
666
|
export type FilterMapping = {
|
|
568
667
|
[k: string]: ContentFilterMode;
|
|
569
668
|
} | ContentFilterMode;
|
|
669
|
+
/**
|
|
670
|
+
* Optional compaction parameters.
|
|
671
|
+
*
|
|
672
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
673
|
+
* via the `definition` "HistoryCompactRequest".
|
|
674
|
+
*/
|
|
675
|
+
/** @experimental */
|
|
676
|
+
export type HistoryCompactRequest = {
|
|
677
|
+
[k: string]: unknown | undefined;
|
|
678
|
+
} | {
|
|
679
|
+
/**
|
|
680
|
+
* Optional user-provided instructions to focus the compaction summary
|
|
681
|
+
*/
|
|
682
|
+
customInstructions?: string;
|
|
683
|
+
/**
|
|
684
|
+
* 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).
|
|
685
|
+
*/
|
|
686
|
+
trigger?: "manual"
|
|
687
|
+
/** Compaction requested while switching to a model with a smaller context window. */
|
|
688
|
+
| "model_switch";
|
|
689
|
+
/**
|
|
690
|
+
* 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.
|
|
691
|
+
*/
|
|
692
|
+
tokenLimit?: number;
|
|
693
|
+
};
|
|
694
|
+
/**
|
|
695
|
+
* Reason a captured file was not restored.
|
|
696
|
+
*
|
|
697
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
698
|
+
* via the `definition` "HistoryFileRestoreSkipReason".
|
|
699
|
+
*/
|
|
700
|
+
/** @experimental */
|
|
701
|
+
export type HistoryFileRestoreSkipReason =
|
|
702
|
+
/** The file changed after Copilot's last captured write. */
|
|
703
|
+
"user-modified"
|
|
704
|
+
/** A faithful preimage was not captured. */
|
|
705
|
+
| "skipped-capture";
|
|
706
|
+
/**
|
|
707
|
+
* Reason a rewind read (rewind points, file-restore preview, or session diff) could not be answered from the session's file-change captures.
|
|
708
|
+
*
|
|
709
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
710
|
+
* via the `definition` "HistoryRewindUnavailableReason".
|
|
711
|
+
*/
|
|
712
|
+
/** @experimental */
|
|
713
|
+
export type HistoryRewindUnavailableReason =
|
|
714
|
+
/** The session did not opt into file-change tracking before its first turn. */
|
|
715
|
+
"file-change-tracking-disabled"
|
|
716
|
+
/** 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. */
|
|
717
|
+
| "session-busy"
|
|
718
|
+
/** Remote-backed rewind routing is not supported. */
|
|
719
|
+
| "unsupported-remote-session";
|
|
720
|
+
/**
|
|
721
|
+
* Aggregate file change represented by a rewind preview.
|
|
722
|
+
*
|
|
723
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
724
|
+
* via the `definition` "HistoryRewindChangeType".
|
|
725
|
+
*/
|
|
726
|
+
/** @experimental */
|
|
727
|
+
export type HistoryRewindChangeType =
|
|
728
|
+
/** The discarded turns created the file. */
|
|
729
|
+
"created"
|
|
730
|
+
/** The discarded turns deleted the file. */
|
|
731
|
+
| "deleted"
|
|
732
|
+
/** The discarded turns modified the file. */
|
|
733
|
+
| "modified";
|
|
734
|
+
/**
|
|
735
|
+
* Scope of a rewind operation.
|
|
736
|
+
*
|
|
737
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
738
|
+
* via the `definition` "HistoryRewindMode".
|
|
739
|
+
*/
|
|
740
|
+
/** @experimental */
|
|
741
|
+
export type HistoryRewindMode =
|
|
742
|
+
/** Discard conversation events while leaving files unchanged. */
|
|
743
|
+
"conversation"
|
|
744
|
+
/** Discard conversation events and restore captured files changed by those turns. */
|
|
745
|
+
| "conversation-and-files";
|
|
746
|
+
/**
|
|
747
|
+
* Outcome of a rewind request.
|
|
748
|
+
*
|
|
749
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
750
|
+
* via the `definition` "HistoryRewindOutcome".
|
|
751
|
+
*/
|
|
752
|
+
/** @experimental */
|
|
753
|
+
export type HistoryRewindOutcome =
|
|
754
|
+
/** The requested rewind completed; reachable in either mode. */
|
|
755
|
+
"success"
|
|
756
|
+
/** The session still has work that may mutate files or history; reachable in either mode. */
|
|
757
|
+
| "session-busy"
|
|
758
|
+
/** A conversation-and-files rewind was requested for a session that did not enable capture; conversation-only rewinds never produce this. */
|
|
759
|
+
| "file-change-tracking-disabled"
|
|
760
|
+
/** Remote-backed rewind routing is not supported; reachable in either mode. */
|
|
761
|
+
| "unsupported-remote-session"
|
|
762
|
+
/** File restore failed and all applied file changes were rolled back; only conversation-and-files rewinds produce this. */
|
|
763
|
+
| "files-rolled-back"
|
|
764
|
+
/** File restore failed and its rollback could not fully restore the pre-rewind state; only conversation-and-files rewinds produce this. */
|
|
765
|
+
| "rollback-incomplete"
|
|
766
|
+
/** 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. */
|
|
767
|
+
| "truncation-failed"
|
|
768
|
+
/** 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. */
|
|
769
|
+
| "checkpoint-cleanup-failed"
|
|
770
|
+
/** Files and conversation were rewound, but obsolete file snapshots could not be removed; only conversation-and-files rewinds produce this. */
|
|
771
|
+
| "snapshot-prune-failed";
|
|
570
772
|
/**
|
|
571
773
|
* Source for direct repo installs (when marketplace is empty)
|
|
572
774
|
*
|
|
@@ -1115,6 +1317,21 @@ export type ModelPickerPriceCategory =
|
|
|
1115
1317
|
| "high"
|
|
1116
1318
|
/** Highest relative token cost tier. */
|
|
1117
1319
|
| "very_high";
|
|
1320
|
+
/**
|
|
1321
|
+
* Optional listing options.
|
|
1322
|
+
*
|
|
1323
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1324
|
+
* via the `definition` "ModelListRequest".
|
|
1325
|
+
*/
|
|
1326
|
+
/** @experimental */
|
|
1327
|
+
export type ModelListRequest = {
|
|
1328
|
+
[k: string]: unknown | undefined;
|
|
1329
|
+
} | {
|
|
1330
|
+
/**
|
|
1331
|
+
* If true, bypasses the per-session model list cache and re-fetches from CAPI.
|
|
1332
|
+
*/
|
|
1333
|
+
skipCache?: boolean;
|
|
1334
|
+
};
|
|
1118
1335
|
/**
|
|
1119
1336
|
* Provider type. Defaults to "openai" for generic OpenAI-compatible APIs.
|
|
1120
1337
|
*
|
|
@@ -1315,6 +1532,37 @@ export type PermissionsSetApproveAllSource =
|
|
|
1315
1532
|
| "autopilot_confirmation"
|
|
1316
1533
|
/** Allow-all was enabled through an RPC caller. */
|
|
1317
1534
|
| "rpc";
|
|
1535
|
+
/**
|
|
1536
|
+
* Optional flags controlling which side effects the reload performs.
|
|
1537
|
+
*
|
|
1538
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1539
|
+
* via the `definition` "PluginsReloadRequest".
|
|
1540
|
+
*/
|
|
1541
|
+
/** @experimental */
|
|
1542
|
+
export type PluginsReloadRequest = {
|
|
1543
|
+
[k: string]: unknown | undefined;
|
|
1544
|
+
} | {
|
|
1545
|
+
/**
|
|
1546
|
+
* Reload MCP server connections after refreshing plugins. Defaults to true.
|
|
1547
|
+
*/
|
|
1548
|
+
reloadMcp?: boolean;
|
|
1549
|
+
/**
|
|
1550
|
+
* Re-run custom-agent discovery after refreshing plugins. Defaults to true.
|
|
1551
|
+
*/
|
|
1552
|
+
reloadCustomAgents?: boolean;
|
|
1553
|
+
/**
|
|
1554
|
+
* 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).
|
|
1555
|
+
*/
|
|
1556
|
+
reloadHooks?: boolean;
|
|
1557
|
+
/**
|
|
1558
|
+
* 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).
|
|
1559
|
+
*/
|
|
1560
|
+
reloadExtensions?: boolean;
|
|
1561
|
+
/**
|
|
1562
|
+
* When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`.
|
|
1563
|
+
*/
|
|
1564
|
+
deferRepoHooks?: boolean;
|
|
1565
|
+
};
|
|
1318
1566
|
/**
|
|
1319
1567
|
* Provider family. Matches the `type` field of a BYOK provider config.
|
|
1320
1568
|
*
|
|
@@ -1353,6 +1601,21 @@ export type ProviderEndpointTransport =
|
|
|
1353
1601
|
"http"
|
|
1354
1602
|
/** WebSocket transport. */
|
|
1355
1603
|
| "websockets";
|
|
1604
|
+
/**
|
|
1605
|
+
* Optional model identifier to scope the endpoint snapshot to.
|
|
1606
|
+
*
|
|
1607
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1608
|
+
* via the `definition` "ProviderGetEndpointRequest".
|
|
1609
|
+
*/
|
|
1610
|
+
/** @experimental */
|
|
1611
|
+
export type ProviderGetEndpointRequest = {
|
|
1612
|
+
[k: string]: unknown | undefined;
|
|
1613
|
+
} | {
|
|
1614
|
+
/**
|
|
1615
|
+
* 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.
|
|
1616
|
+
*/
|
|
1617
|
+
modelId?: string;
|
|
1618
|
+
};
|
|
1356
1619
|
/**
|
|
1357
1620
|
* Attachment union accepted by push input, covering files, directories, GitHub objects, blobs, snippets, and extension context.
|
|
1358
1621
|
*
|
|
@@ -1375,6 +1638,34 @@ export type PushAttachmentGitHubReferenceType =
|
|
|
1375
1638
|
| "pr"
|
|
1376
1639
|
/** GitHub discussion reference. */
|
|
1377
1640
|
| "discussion";
|
|
1641
|
+
/**
|
|
1642
|
+
* The UI mode the agent was in when this message was sent. Defaults to the session's current mode.
|
|
1643
|
+
*
|
|
1644
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1645
|
+
* via the `definition` "SendAgentMode".
|
|
1646
|
+
*/
|
|
1647
|
+
/** @experimental */
|
|
1648
|
+
export type SendAgentMode =
|
|
1649
|
+
/** The agent is responding interactively to the user. */
|
|
1650
|
+
"interactive"
|
|
1651
|
+
/** The agent is preparing a plan before making changes. */
|
|
1652
|
+
| "plan"
|
|
1653
|
+
/** The agent is working autonomously toward task completion. */
|
|
1654
|
+
| "autopilot"
|
|
1655
|
+
/** The agent is in shell-focused UI mode. */
|
|
1656
|
+
| "shell";
|
|
1657
|
+
/**
|
|
1658
|
+
* How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn.
|
|
1659
|
+
*
|
|
1660
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1661
|
+
* via the `definition` "SendMode".
|
|
1662
|
+
*/
|
|
1663
|
+
/** @experimental */
|
|
1664
|
+
export type SendMode =
|
|
1665
|
+
/** Append the message to the normal session queue. */
|
|
1666
|
+
"enqueue"
|
|
1667
|
+
/** Interject the message during the in-progress turn. */
|
|
1668
|
+
| "immediate";
|
|
1378
1669
|
/**
|
|
1379
1670
|
* Whether this item is a queued user message or a queued slash command / model change
|
|
1380
1671
|
*
|
|
@@ -1421,34 +1712,6 @@ export type RemoteSessionMetadataTaskType =
|
|
|
1421
1712
|
"cca"
|
|
1422
1713
|
/** CLI remote task. */
|
|
1423
1714
|
| "cli";
|
|
1424
|
-
/**
|
|
1425
|
-
* The UI mode the agent was in when this message was sent. Defaults to the session's current mode.
|
|
1426
|
-
*
|
|
1427
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1428
|
-
* via the `definition` "SendAgentMode".
|
|
1429
|
-
*/
|
|
1430
|
-
/** @experimental */
|
|
1431
|
-
export type SendAgentMode =
|
|
1432
|
-
/** The agent is responding interactively to the user. */
|
|
1433
|
-
"interactive"
|
|
1434
|
-
/** The agent is preparing a plan before making changes. */
|
|
1435
|
-
| "plan"
|
|
1436
|
-
/** The agent is working autonomously toward task completion. */
|
|
1437
|
-
| "autopilot"
|
|
1438
|
-
/** The agent is in shell-focused UI mode. */
|
|
1439
|
-
| "shell";
|
|
1440
|
-
/**
|
|
1441
|
-
* How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn.
|
|
1442
|
-
*
|
|
1443
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1444
|
-
* via the `definition` "SendMode".
|
|
1445
|
-
*/
|
|
1446
|
-
/** @experimental */
|
|
1447
|
-
export type SendMode =
|
|
1448
|
-
/** Append the message to the normal session queue. */
|
|
1449
|
-
"enqueue"
|
|
1450
|
-
/** Interject the message during the in-progress turn. */
|
|
1451
|
-
| "immediate";
|
|
1452
1715
|
/**
|
|
1453
1716
|
* Session capability enabled for this session
|
|
1454
1717
|
*
|
|
@@ -1529,6 +1792,20 @@ export type SessionFsSqliteQueryType =
|
|
|
1529
1792
|
| "query"
|
|
1530
1793
|
/** Execute INSERT, UPDATE, or DELETE SQL and return affected-row metadata. */
|
|
1531
1794
|
| "run";
|
|
1795
|
+
/**
|
|
1796
|
+
* SQLite transaction failure classification.
|
|
1797
|
+
*
|
|
1798
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1799
|
+
* via the `definition` "SessionFsSqliteTransactionErrorClass".
|
|
1800
|
+
*/
|
|
1801
|
+
/** @experimental */
|
|
1802
|
+
export type SessionFsSqliteTransactionErrorClass =
|
|
1803
|
+
/** SQLite reported BUSY or LOCKED before commit; the transaction was rolled back and may be retried. */
|
|
1804
|
+
"busyOrLocked"
|
|
1805
|
+
/** The statement, database, or provider failed definitively and must not be retried automatically. */
|
|
1806
|
+
| "fatal"
|
|
1807
|
+
/** The transport failed after the provider may have committed; retrying could duplicate effects. */
|
|
1808
|
+
| "postCommitAmbiguous";
|
|
1532
1809
|
/**
|
|
1533
1810
|
* Source descriptor for direct repo installs (when marketplace is empty)
|
|
1534
1811
|
*
|
|
@@ -1538,10 +1815,94 @@ export type SessionFsSqliteQueryType =
|
|
|
1538
1815
|
/** @experimental */
|
|
1539
1816
|
export type SessionInstalledPluginSource = string | SessionInstalledPluginSourceGitHub | SessionInstalledPluginSourceUrl | SessionInstalledPluginSourceLocal;
|
|
1540
1817
|
/**
|
|
1541
|
-
*
|
|
1818
|
+
* Client population used for the prediction baseline.
|
|
1542
1819
|
*
|
|
1543
1820
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1544
|
-
* via the `definition` "
|
|
1821
|
+
* via the `definition` "SessionLimitPredictionClientType".
|
|
1822
|
+
*/
|
|
1823
|
+
/** @experimental */
|
|
1824
|
+
export type SessionLimitPredictionClientType =
|
|
1825
|
+
/** Interactive CLI sessions where a user can accept, edit, or top up the limit. */
|
|
1826
|
+
"cli-interactive"
|
|
1827
|
+
/** Prompt/non-interactive CLI sessions where the initial limit must cover more of the run. */
|
|
1828
|
+
| "cli-prompt";
|
|
1829
|
+
/**
|
|
1830
|
+
* Baseline fallback level used to create the prediction.
|
|
1831
|
+
*
|
|
1832
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1833
|
+
* via the `definition` "SessionLimitPredictionSource".
|
|
1834
|
+
*/
|
|
1835
|
+
/** @experimental */
|
|
1836
|
+
export type SessionLimitPredictionSource =
|
|
1837
|
+
/** The prediction used the exact resolved model's baseline cell. */
|
|
1838
|
+
"model"
|
|
1839
|
+
/** The exact model was unavailable, so the prediction used the model family's baseline cell. */
|
|
1840
|
+
| "family"
|
|
1841
|
+
/** No model or family cell was available, so the prediction used the global client-type baseline cell. */
|
|
1842
|
+
| "global";
|
|
1843
|
+
/**
|
|
1844
|
+
* Semantic usage tier used for a recommended cap or additional headroom.
|
|
1845
|
+
*
|
|
1846
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1847
|
+
* via the `definition` "SessionLimitPredictionTier".
|
|
1848
|
+
*/
|
|
1849
|
+
/** @experimental */
|
|
1850
|
+
export type SessionLimitPredictionTier =
|
|
1851
|
+
/** Recommended starting tier. */
|
|
1852
|
+
"recommended"
|
|
1853
|
+
/** Additional headroom for longer-running sessions. */
|
|
1854
|
+
| "additional_headroom"
|
|
1855
|
+
/** Generous headroom for unusually high usage. */
|
|
1856
|
+
| "generous_headroom"
|
|
1857
|
+
/** Maximum available headroom tier. */
|
|
1858
|
+
| "maximum_headroom";
|
|
1859
|
+
/**
|
|
1860
|
+
* Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model.
|
|
1861
|
+
*
|
|
1862
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1863
|
+
* via the `definition` "SessionLimitPredictionRequest".
|
|
1864
|
+
*/
|
|
1865
|
+
/** @experimental */
|
|
1866
|
+
export type SessionLimitPredictionRequest = {
|
|
1867
|
+
[k: string]: unknown | undefined;
|
|
1868
|
+
} | {
|
|
1869
|
+
/**
|
|
1870
|
+
* Optional model identifier override. If omitted, the session's current model is used.
|
|
1871
|
+
*/
|
|
1872
|
+
modelId?: string;
|
|
1873
|
+
clientType?: SessionLimitPredictionClientType;
|
|
1874
|
+
};
|
|
1875
|
+
/**
|
|
1876
|
+
* Prediction result. Available results include prediction details; unavailable results include an explicit reason.
|
|
1877
|
+
*
|
|
1878
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1879
|
+
* via the `definition` "SessionLimitPredictionResult".
|
|
1880
|
+
*/
|
|
1881
|
+
/** @experimental */
|
|
1882
|
+
export type SessionLimitPredictionResult = {
|
|
1883
|
+
prediction: SessionLimitPredictionDetails;
|
|
1884
|
+
kind: "available";
|
|
1885
|
+
} | {
|
|
1886
|
+
reason: SessionLimitPredictionUnavailableReason;
|
|
1887
|
+
kind: "unavailable";
|
|
1888
|
+
};
|
|
1889
|
+
/**
|
|
1890
|
+
* Reason a prediction could not be computed.
|
|
1891
|
+
*
|
|
1892
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1893
|
+
* via the `definition` "SessionLimitPredictionUnavailableReason".
|
|
1894
|
+
*/
|
|
1895
|
+
/** @experimental */
|
|
1896
|
+
export type SessionLimitPredictionUnavailableReason =
|
|
1897
|
+
/** The current model is auto and has not resolved to a concrete model yet. */
|
|
1898
|
+
"auto_unresolved"
|
|
1899
|
+
/** No model was provided and the session does not currently have a selected model. */
|
|
1900
|
+
| "no_model";
|
|
1901
|
+
/**
|
|
1902
|
+
* Local or remote session metadata entry. Narrow on `isRemote` to access source-specific fields.
|
|
1903
|
+
*
|
|
1904
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1905
|
+
* via the `definition` "SessionListEntry".
|
|
1545
1906
|
*/
|
|
1546
1907
|
/** @experimental */
|
|
1547
1908
|
export type SessionListEntry = LocalSessionMetadataValue | RemoteSessionMetadataValue;
|
|
@@ -1617,6 +1978,30 @@ export type SessionOpenOptionsReasoningSummary =
|
|
|
1617
1978
|
| "concise"
|
|
1618
1979
|
/** Request a detailed summary of model reasoning. */
|
|
1619
1980
|
| "detailed";
|
|
1981
|
+
/**
|
|
1982
|
+
* Controls automatic non-interactive profile loading where supported. Explicit initScripts are unaffected.
|
|
1983
|
+
*
|
|
1984
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1985
|
+
* via the `definition` "ShellInitProfile".
|
|
1986
|
+
*/
|
|
1987
|
+
/** @experimental */
|
|
1988
|
+
export type ShellInitProfile =
|
|
1989
|
+
/** Disable automatic non-interactive profile loading. Explicit initScripts still run. */
|
|
1990
|
+
"none"
|
|
1991
|
+
/** Allow automatic non-interactive profile loading when supported. Explicit initScripts still run. */
|
|
1992
|
+
| "non-interactive";
|
|
1993
|
+
/**
|
|
1994
|
+
* Supported built-in shells for initialization scripts.
|
|
1995
|
+
*
|
|
1996
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1997
|
+
* via the `definition` "ShellInitScriptShell".
|
|
1998
|
+
*/
|
|
1999
|
+
/** @experimental */
|
|
2000
|
+
export type ShellInitScriptShell =
|
|
2001
|
+
/** Source the script in the built-in Bash shell on macOS and Linux. */
|
|
2002
|
+
"bash"
|
|
2003
|
+
/** Source the script in the built-in PowerShell shell on Windows. */
|
|
2004
|
+
| "powershell";
|
|
1620
2005
|
/**
|
|
1621
2006
|
* How MCP server environment values are interpreted.
|
|
1622
2007
|
*
|
|
@@ -2074,6 +2459,14 @@ export type WorkspacesWorkspaceDetailsHostType =
|
|
|
2074
2459
|
*/
|
|
2075
2460
|
/** @experimental */
|
|
2076
2461
|
export type AccountGetAllUsersResult = AccountAllUsers[];
|
|
2462
|
+
/**
|
|
2463
|
+
* The number of running background agents (task-registry agents) that were cancelled.
|
|
2464
|
+
*
|
|
2465
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2466
|
+
* via the `definition` "SessionCancelAllBackgroundAgentsResult".
|
|
2467
|
+
*/
|
|
2468
|
+
/** @experimental */
|
|
2469
|
+
export type SessionCancelAllBackgroundAgentsResult = number;
|
|
2077
2470
|
/**
|
|
2078
2471
|
* Parameters for aborting the current turn
|
|
2079
2472
|
*
|
|
@@ -2794,7 +3187,7 @@ export interface AgentGetCurrentResult {
|
|
|
2794
3187
|
agent?: AgentInfo | null;
|
|
2795
3188
|
}
|
|
2796
3189
|
/**
|
|
2797
|
-
*
|
|
3190
|
+
* Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path.
|
|
2798
3191
|
*
|
|
2799
3192
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2800
3193
|
* via the `definition` "AgentInfo".
|
|
@@ -2802,7 +3195,7 @@ export interface AgentGetCurrentResult {
|
|
|
2802
3195
|
/** @experimental */
|
|
2803
3196
|
export interface AgentInfo {
|
|
2804
3197
|
/**
|
|
2805
|
-
*
|
|
3198
|
+
* Name of the agent. Use `id` as the stable selection identifier.
|
|
2806
3199
|
*/
|
|
2807
3200
|
name: string;
|
|
2808
3201
|
/**
|
|
@@ -2831,7 +3224,7 @@ export interface AgentInfo {
|
|
|
2831
3224
|
*/
|
|
2832
3225
|
tools?: string[];
|
|
2833
3226
|
/**
|
|
2834
|
-
*
|
|
3227
|
+
* Authored preferred model id for this agent. Runtime model selection may choose a different model; omitted means no authored preference.
|
|
2835
3228
|
*/
|
|
2836
3229
|
model?: string;
|
|
2837
3230
|
/**
|
|
@@ -2846,9 +3239,13 @@ export interface AgentInfo {
|
|
|
2846
3239
|
* Skill names preloaded into this agent's context. Omitted means none.
|
|
2847
3240
|
*/
|
|
2848
3241
|
skills?: string[];
|
|
3242
|
+
/**
|
|
3243
|
+
* 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.
|
|
3244
|
+
*/
|
|
3245
|
+
prompt?: string;
|
|
2849
3246
|
}
|
|
2850
3247
|
/**
|
|
2851
|
-
*
|
|
3248
|
+
* Agents available to the session.
|
|
2852
3249
|
*
|
|
2853
3250
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2854
3251
|
* via the `definition` "AgentList".
|
|
@@ -2856,7 +3253,7 @@ export interface AgentInfo {
|
|
|
2856
3253
|
/** @experimental */
|
|
2857
3254
|
export interface AgentList {
|
|
2858
3255
|
/**
|
|
2859
|
-
* Available
|
|
3256
|
+
* Available agents
|
|
2860
3257
|
*/
|
|
2861
3258
|
agents: AgentInfo[];
|
|
2862
3259
|
}
|
|
@@ -3160,6 +3557,32 @@ export interface AllowAllPermissionState {
|
|
|
3160
3557
|
enabled: boolean;
|
|
3161
3558
|
mode?: PermissionsAllowAllMode;
|
|
3162
3559
|
}
|
|
3560
|
+
/**
|
|
3561
|
+
* The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata.
|
|
3562
|
+
*
|
|
3563
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3564
|
+
* via the `definition` "BuiltInModelCatalog".
|
|
3565
|
+
*/
|
|
3566
|
+
/** @experimental */
|
|
3567
|
+
export interface BuiltInModelCatalog {
|
|
3568
|
+
/**
|
|
3569
|
+
* Built-in model entries.
|
|
3570
|
+
*/
|
|
3571
|
+
models: BuiltInModelCatalogEntry[];
|
|
3572
|
+
}
|
|
3573
|
+
/**
|
|
3574
|
+
* A well-known model in the runtime's built-in catalog.
|
|
3575
|
+
*
|
|
3576
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3577
|
+
* via the `definition` "BuiltInModelCatalogEntry".
|
|
3578
|
+
*/
|
|
3579
|
+
/** @experimental */
|
|
3580
|
+
export interface BuiltInModelCatalogEntry {
|
|
3581
|
+
/**
|
|
3582
|
+
* Well-known runtime model ID suitable for `ProviderConfig.modelId` or `ProviderModelConfig.modelId`. This is not necessarily the provider-facing deployment or model name and does not indicate CAPI entitlement or provider availability.
|
|
3583
|
+
*/
|
|
3584
|
+
id: string;
|
|
3585
|
+
}
|
|
3163
3586
|
/**
|
|
3164
3587
|
* Cancellation result for a user-requested shell command.
|
|
3165
3588
|
*
|
|
@@ -3690,27 +4113,6 @@ export interface CommandsInvokeRequest {
|
|
|
3690
4113
|
*/
|
|
3691
4114
|
input?: string;
|
|
3692
4115
|
}
|
|
3693
|
-
/**
|
|
3694
|
-
* Optional filters controlling which command sources to include in the listing.
|
|
3695
|
-
*
|
|
3696
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3697
|
-
* via the `definition` "CommandsListRequest".
|
|
3698
|
-
*/
|
|
3699
|
-
/** @experimental */
|
|
3700
|
-
export interface CommandsListRequest {
|
|
3701
|
-
/**
|
|
3702
|
-
* Include runtime built-in commands
|
|
3703
|
-
*/
|
|
3704
|
-
includeBuiltins?: boolean;
|
|
3705
|
-
/**
|
|
3706
|
-
* Include enabled user-invocable skills and commands
|
|
3707
|
-
*/
|
|
3708
|
-
includeSkills?: boolean;
|
|
3709
|
-
/**
|
|
3710
|
-
* Include commands registered by protocol clients, including SDK clients and extensions
|
|
3711
|
-
*/
|
|
3712
|
-
includeClientCommands?: boolean;
|
|
3713
|
-
}
|
|
3714
4116
|
/**
|
|
3715
4117
|
* Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands).
|
|
3716
4118
|
*
|
|
@@ -3921,6 +4323,53 @@ export interface ConnectRemoteSessionParams {
|
|
|
3921
4323
|
*/
|
|
3922
4324
|
sessionId: string;
|
|
3923
4325
|
}
|
|
4326
|
+
/**
|
|
4327
|
+
* Local file system absolute paths within the session working directory to check against its content-exclusion policy.
|
|
4328
|
+
*
|
|
4329
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4330
|
+
* via the `definition` "ContentExclusionCheckPathsRequest".
|
|
4331
|
+
*/
|
|
4332
|
+
/** @experimental */
|
|
4333
|
+
export interface ContentExclusionCheckPathsRequest {
|
|
4334
|
+
/**
|
|
4335
|
+
* Local file system absolute paths within the session working directory to check. Results are returned in the same order, including duplicates.
|
|
4336
|
+
*/
|
|
4337
|
+
paths: string[];
|
|
4338
|
+
}
|
|
4339
|
+
/**
|
|
4340
|
+
* Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable.
|
|
4341
|
+
*
|
|
4342
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4343
|
+
* via the `definition` "ContentExclusionCheckPathsResult".
|
|
4344
|
+
*/
|
|
4345
|
+
/** @experimental */
|
|
4346
|
+
export interface ContentExclusionCheckPathsResult {
|
|
4347
|
+
/**
|
|
4348
|
+
* 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.
|
|
4349
|
+
*/
|
|
4350
|
+
available: boolean;
|
|
4351
|
+
/**
|
|
4352
|
+
* Per-path decisions in request order. Empty when available is false.
|
|
4353
|
+
*/
|
|
4354
|
+
checks: ContentExclusionPathCheck[];
|
|
4355
|
+
}
|
|
4356
|
+
/**
|
|
4357
|
+
* Content-exclusion decision for one requested path.
|
|
4358
|
+
*
|
|
4359
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4360
|
+
* via the `definition` "ContentExclusionPathCheck".
|
|
4361
|
+
*/
|
|
4362
|
+
/** @experimental */
|
|
4363
|
+
export interface ContentExclusionPathCheck {
|
|
4364
|
+
/**
|
|
4365
|
+
* The path supplied by the caller.
|
|
4366
|
+
*/
|
|
4367
|
+
path: string;
|
|
4368
|
+
/**
|
|
4369
|
+
* Whether the session's complete content-exclusion policy excludes the path.
|
|
4370
|
+
*/
|
|
4371
|
+
excluded: boolean;
|
|
4372
|
+
}
|
|
3924
4373
|
/**
|
|
3925
4374
|
* A single large message currently in context.
|
|
3926
4375
|
*
|
|
@@ -4214,6 +4663,10 @@ export interface EventLogReadRequest {
|
|
|
4214
4663
|
waitMs?: number;
|
|
4215
4664
|
types?: EventLogTypes;
|
|
4216
4665
|
agentScope?: EventsAgentScope;
|
|
4666
|
+
/**
|
|
4667
|
+
* 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).
|
|
4668
|
+
*/
|
|
4669
|
+
includeEphemeral?: boolean;
|
|
4217
4670
|
}
|
|
4218
4671
|
/**
|
|
4219
4672
|
* Indicates whether the operation succeeded.
|
|
@@ -4250,7 +4703,7 @@ export interface EventLogTailResult {
|
|
|
4250
4703
|
/** @experimental */
|
|
4251
4704
|
export interface EventsReadResult {
|
|
4252
4705
|
/**
|
|
4253
|
-
*
|
|
4706
|
+
* 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`.
|
|
4254
4707
|
*/
|
|
4255
4708
|
events: SessionEvent[];
|
|
4256
4709
|
/**
|
|
@@ -4704,6 +5157,10 @@ export interface FactoryAgentRequest {
|
|
|
4704
5157
|
* Factory run identifier that owns the subagent.
|
|
4705
5158
|
*/
|
|
4706
5159
|
factoryRunId: string;
|
|
5160
|
+
/**
|
|
5161
|
+
* Opaque token identifying the current factory execution attempt.
|
|
5162
|
+
*/
|
|
5163
|
+
executionToken: string;
|
|
4707
5164
|
/**
|
|
4708
5165
|
* Prompt to send to the subagent.
|
|
4709
5166
|
*/
|
|
@@ -4725,6 +5182,28 @@ export interface FactoryAgentResult {
|
|
|
4725
5182
|
[k: string]: unknown | undefined;
|
|
4726
5183
|
};
|
|
4727
5184
|
}
|
|
5185
|
+
/**
|
|
5186
|
+
* Prompt-safe durable identity and live status for a direct factory agent.
|
|
5187
|
+
*
|
|
5188
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5189
|
+
* via the `definition` "FactoryAgentSummary".
|
|
5190
|
+
*/
|
|
5191
|
+
/** @experimental */
|
|
5192
|
+
export interface FactoryAgentSummary {
|
|
5193
|
+
agentId: string;
|
|
5194
|
+
toolCallId: string;
|
|
5195
|
+
runId: string;
|
|
5196
|
+
phaseId: string | null;
|
|
5197
|
+
label: string;
|
|
5198
|
+
agentType: string;
|
|
5199
|
+
status: string;
|
|
5200
|
+
requestedModel?: string;
|
|
5201
|
+
resolvedModel?: string;
|
|
5202
|
+
startedAt?: number;
|
|
5203
|
+
completedAt?: number;
|
|
5204
|
+
activeMs: number;
|
|
5205
|
+
activity?: string;
|
|
5206
|
+
}
|
|
4728
5207
|
/**
|
|
4729
5208
|
* Parameters for cancelling a factory run.
|
|
4730
5209
|
*
|
|
@@ -4738,6 +5217,30 @@ export interface FactoryCancelRequest {
|
|
|
4738
5217
|
*/
|
|
4739
5218
|
runId: string;
|
|
4740
5219
|
}
|
|
5220
|
+
/**
|
|
5221
|
+
* Current factory phase identity.
|
|
5222
|
+
*
|
|
5223
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5224
|
+
* via the `definition` "FactoryCurrentPhase".
|
|
5225
|
+
*/
|
|
5226
|
+
/** @experimental */
|
|
5227
|
+
export interface FactoryCurrentPhase {
|
|
5228
|
+
id: string;
|
|
5229
|
+
ordinal: number | null;
|
|
5230
|
+
}
|
|
5231
|
+
/**
|
|
5232
|
+
* Declared or approved factory resource ceilings.
|
|
5233
|
+
*
|
|
5234
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5235
|
+
* via the `definition` "FactoryDeclaredLimits".
|
|
5236
|
+
*/
|
|
5237
|
+
/** @experimental */
|
|
5238
|
+
export interface FactoryDeclaredLimits {
|
|
5239
|
+
maxConcurrentSubagents?: number;
|
|
5240
|
+
maxTotalSubagents?: number;
|
|
5241
|
+
timeoutSeconds?: number;
|
|
5242
|
+
maxAiCredits?: number;
|
|
5243
|
+
}
|
|
4741
5244
|
/**
|
|
4742
5245
|
* Parameters sent to the owning extension to execute a factory closure.
|
|
4743
5246
|
*
|
|
@@ -4758,6 +5261,10 @@ export interface FactoryExecuteRequest {
|
|
|
4758
5261
|
* Factory run identifier.
|
|
4759
5262
|
*/
|
|
4760
5263
|
runId: string;
|
|
5264
|
+
/**
|
|
5265
|
+
* Opaque token identifying this factory execution attempt.
|
|
5266
|
+
*/
|
|
5267
|
+
executionToken: string;
|
|
4761
5268
|
/**
|
|
4762
5269
|
* Factory input value.
|
|
4763
5270
|
*/
|
|
@@ -4776,10 +5283,39 @@ export interface FactoryExecuteResult {
|
|
|
4776
5283
|
/**
|
|
4777
5284
|
* Factory result value.
|
|
4778
5285
|
*/
|
|
4779
|
-
result
|
|
5286
|
+
result?: {
|
|
4780
5287
|
[k: string]: unknown | undefined;
|
|
4781
5288
|
};
|
|
4782
5289
|
}
|
|
5290
|
+
/**
|
|
5291
|
+
* Parameters for paging factory progress.
|
|
5292
|
+
*
|
|
5293
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5294
|
+
* via the `definition` "FactoryGetRunProgressRequest".
|
|
5295
|
+
*/
|
|
5296
|
+
/** @experimental */
|
|
5297
|
+
export interface FactoryGetRunProgressRequest {
|
|
5298
|
+
/**
|
|
5299
|
+
* Factory run identifier.
|
|
5300
|
+
*/
|
|
5301
|
+
runId: string;
|
|
5302
|
+
/**
|
|
5303
|
+
* Optional phase identifier used to scope records and cursors.
|
|
5304
|
+
*/
|
|
5305
|
+
phaseId?: string;
|
|
5306
|
+
/**
|
|
5307
|
+
* Exclusive forward cursor.
|
|
5308
|
+
*/
|
|
5309
|
+
afterSeq?: number;
|
|
5310
|
+
/**
|
|
5311
|
+
* Exclusive backward cursor.
|
|
5312
|
+
*/
|
|
5313
|
+
beforeSeq?: number;
|
|
5314
|
+
/**
|
|
5315
|
+
* Maximum records to return. Defaults to 200 and is capped at 500.
|
|
5316
|
+
*/
|
|
5317
|
+
limit?: number;
|
|
5318
|
+
}
|
|
4783
5319
|
/**
|
|
4784
5320
|
* Parameters for retrieving a factory run.
|
|
4785
5321
|
*
|
|
@@ -4805,6 +5341,10 @@ export interface FactoryJournalGetRequest {
|
|
|
4805
5341
|
* Factory run identifier.
|
|
4806
5342
|
*/
|
|
4807
5343
|
runId: string;
|
|
5344
|
+
/**
|
|
5345
|
+
* Opaque token identifying the current factory execution attempt.
|
|
5346
|
+
*/
|
|
5347
|
+
executionToken: string;
|
|
4808
5348
|
/**
|
|
4809
5349
|
* Namespaced journal key.
|
|
4810
5350
|
*/
|
|
@@ -4841,6 +5381,10 @@ export interface FactoryJournalPutRequest {
|
|
|
4841
5381
|
* Factory run identifier.
|
|
4842
5382
|
*/
|
|
4843
5383
|
runId: string;
|
|
5384
|
+
/**
|
|
5385
|
+
* Opaque token identifying the current factory execution attempt.
|
|
5386
|
+
*/
|
|
5387
|
+
executionToken: string;
|
|
4844
5388
|
/**
|
|
4845
5389
|
* Namespaced journal key.
|
|
4846
5390
|
*/
|
|
@@ -4852,6 +5396,78 @@ export interface FactoryJournalPutRequest {
|
|
|
4852
5396
|
[k: string]: unknown | undefined;
|
|
4853
5397
|
};
|
|
4854
5398
|
}
|
|
5399
|
+
/**
|
|
5400
|
+
* Empty parameters for listing factory runs.
|
|
5401
|
+
*
|
|
5402
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5403
|
+
* via the `definition` "FactoryListRunsRequest".
|
|
5404
|
+
*/
|
|
5405
|
+
/** @experimental */
|
|
5406
|
+
export interface FactoryListRunsRequest {
|
|
5407
|
+
}
|
|
5408
|
+
/**
|
|
5409
|
+
* Factory runs in durable creation order.
|
|
5410
|
+
*
|
|
5411
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5412
|
+
* via the `definition` "FactoryListRunsResult".
|
|
5413
|
+
*/
|
|
5414
|
+
/** @experimental */
|
|
5415
|
+
export interface FactoryListRunsResult {
|
|
5416
|
+
runs: FactoryRunSummary[];
|
|
5417
|
+
}
|
|
5418
|
+
/**
|
|
5419
|
+
* Durable factory run summary with read-time live overlays.
|
|
5420
|
+
*
|
|
5421
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5422
|
+
* via the `definition` "FactoryRunSummary".
|
|
5423
|
+
*/
|
|
5424
|
+
/** @experimental */
|
|
5425
|
+
export interface FactoryRunSummary {
|
|
5426
|
+
runId: string;
|
|
5427
|
+
factoryName: string;
|
|
5428
|
+
description: string;
|
|
5429
|
+
status: FactoryRunStatus;
|
|
5430
|
+
revision: number;
|
|
5431
|
+
createdAt: number;
|
|
5432
|
+
startedAt: number | null;
|
|
5433
|
+
updatedAt: number;
|
|
5434
|
+
completedAt: number | null;
|
|
5435
|
+
currentPhase: FactoryCurrentPhase | null;
|
|
5436
|
+
declaredPhaseCount: number;
|
|
5437
|
+
liveAgentCount: number;
|
|
5438
|
+
totalSpawnedAgentCount: number;
|
|
5439
|
+
consumed: FactoryRunConsumed;
|
|
5440
|
+
declaredLimits: FactoryDeclaredLimits;
|
|
5441
|
+
approved: FactoryDeclaredLimits | null;
|
|
5442
|
+
observedAt: number;
|
|
5443
|
+
activeSegmentStartedAt: number | null;
|
|
5444
|
+
terminal: FactoryRunTerminal | null;
|
|
5445
|
+
}
|
|
5446
|
+
/**
|
|
5447
|
+
* Durable factory resource consumption.
|
|
5448
|
+
*
|
|
5449
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5450
|
+
* via the `definition` "FactoryRunConsumed".
|
|
5451
|
+
*/
|
|
5452
|
+
/** @experimental */
|
|
5453
|
+
export interface FactoryRunConsumed {
|
|
5454
|
+
activeMs: number;
|
|
5455
|
+
subagents: number;
|
|
5456
|
+
nanoAiu: number;
|
|
5457
|
+
}
|
|
5458
|
+
/**
|
|
5459
|
+
* Prompt-safe terminal factory outcome.
|
|
5460
|
+
*
|
|
5461
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5462
|
+
* via the `definition` "FactoryRunTerminal".
|
|
5463
|
+
*/
|
|
5464
|
+
/** @experimental */
|
|
5465
|
+
export interface FactoryRunTerminal {
|
|
5466
|
+
reason?: string;
|
|
5467
|
+
failure?: FactoryRunFailure;
|
|
5468
|
+
error?: string;
|
|
5469
|
+
resultPreview?: string;
|
|
5470
|
+
}
|
|
4855
5471
|
/**
|
|
4856
5472
|
* One ordered factory progress line.
|
|
4857
5473
|
*
|
|
@@ -4882,65 +5498,137 @@ export interface FactoryLogRequest {
|
|
|
4882
5498
|
* Factory run identifier.
|
|
4883
5499
|
*/
|
|
4884
5500
|
runId: string;
|
|
5501
|
+
/**
|
|
5502
|
+
* Opaque token identifying the current factory execution attempt.
|
|
5503
|
+
*/
|
|
5504
|
+
executionToken: string;
|
|
4885
5505
|
/**
|
|
4886
5506
|
* Ordered progress lines to append.
|
|
4887
5507
|
*/
|
|
4888
5508
|
lines: FactoryLogLine[];
|
|
4889
5509
|
}
|
|
4890
5510
|
/**
|
|
4891
|
-
*
|
|
5511
|
+
* Durable lifecycle and timing for one factory phase.
|
|
4892
5512
|
*
|
|
4893
5513
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4894
|
-
* via the `definition` "
|
|
5514
|
+
* via the `definition` "FactoryPhaseObservation".
|
|
4895
5515
|
*/
|
|
4896
5516
|
/** @experimental */
|
|
4897
|
-
export interface
|
|
5517
|
+
export interface FactoryPhaseObservation {
|
|
5518
|
+
id: string;
|
|
5519
|
+
ordinal: number | null;
|
|
5520
|
+
title: string;
|
|
5521
|
+
detail?: string;
|
|
5522
|
+
status: FactoryPhaseStatus;
|
|
5523
|
+
lastEnteredRunAttempt: number;
|
|
5524
|
+
entryCount: number;
|
|
5525
|
+
startedAt?: number;
|
|
5526
|
+
completedAt?: number;
|
|
5527
|
+
accumulatedActiveMs: number;
|
|
5528
|
+
currentActiveMs: number;
|
|
5529
|
+
totalAgentCount: number;
|
|
5530
|
+
liveAgentCount: number;
|
|
5531
|
+
}
|
|
5532
|
+
/**
|
|
5533
|
+
* One durable factory progress record.
|
|
5534
|
+
*
|
|
5535
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5536
|
+
* via the `definition` "FactoryProgressLine".
|
|
5537
|
+
*/
|
|
5538
|
+
/** @experimental */
|
|
5539
|
+
export interface FactoryProgressLine {
|
|
4898
5540
|
/**
|
|
4899
|
-
*
|
|
5541
|
+
* Global monotonic sequence number within the run.
|
|
4900
5542
|
*/
|
|
4901
|
-
|
|
5543
|
+
seq: number;
|
|
4902
5544
|
/**
|
|
4903
|
-
*
|
|
5545
|
+
* Resume attempt that emitted this record.
|
|
4904
5546
|
*/
|
|
4905
|
-
|
|
5547
|
+
attempt: number;
|
|
4906
5548
|
/**
|
|
4907
|
-
*
|
|
5549
|
+
* Phase active when the record was emitted, or null before any phase.
|
|
4908
5550
|
*/
|
|
4909
|
-
|
|
5551
|
+
phaseId: string | null;
|
|
5552
|
+
/**
|
|
5553
|
+
* Epoch milliseconds when the record was persisted.
|
|
5554
|
+
*/
|
|
5555
|
+
recordedAt: number;
|
|
5556
|
+
kind: FactoryLogLineKind;
|
|
5557
|
+
/**
|
|
5558
|
+
* Prompt-safe progress text.
|
|
5559
|
+
*/
|
|
5560
|
+
text: string;
|
|
4910
5561
|
}
|
|
4911
5562
|
/**
|
|
4912
|
-
*
|
|
5563
|
+
* A bidirectional page of factory progress.
|
|
4913
5564
|
*
|
|
4914
5565
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4915
|
-
* via the `definition` "
|
|
5566
|
+
* via the `definition` "FactoryProgressPage".
|
|
4916
5567
|
*/
|
|
4917
5568
|
/** @experimental */
|
|
4918
|
-
export interface
|
|
4919
|
-
|
|
4920
|
-
|
|
4921
|
-
|
|
4922
|
-
|
|
5569
|
+
export interface FactoryProgressPage {
|
|
5570
|
+
records: FactoryProgressLine[];
|
|
5571
|
+
oldestSeq: number | null;
|
|
5572
|
+
newestSeq: number | null;
|
|
5573
|
+
hasMoreOlder: boolean;
|
|
5574
|
+
hasMoreNewer: boolean;
|
|
4923
5575
|
/**
|
|
4924
|
-
*
|
|
5576
|
+
* Run revision reflected by this page.
|
|
4925
5577
|
*/
|
|
4926
|
-
|
|
4927
|
-
[k: string]: unknown | undefined;
|
|
4928
|
-
};
|
|
4929
|
-
options?: RunOptions;
|
|
5578
|
+
revision: number;
|
|
4930
5579
|
}
|
|
4931
5580
|
/**
|
|
4932
|
-
*
|
|
5581
|
+
* Parameters for resuming a factory run from its persisted identity.
|
|
4933
5582
|
*
|
|
4934
5583
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4935
|
-
* via the `definition` "
|
|
5584
|
+
* via the `definition` "FactoryResumeRequest".
|
|
4936
5585
|
*/
|
|
4937
5586
|
/** @experimental */
|
|
4938
|
-
export interface
|
|
5587
|
+
export interface FactoryResumeRequest {
|
|
5588
|
+
/**
|
|
5589
|
+
* Factory run identifier.
|
|
5590
|
+
*/
|
|
5591
|
+
runId: string;
|
|
4939
5592
|
limits?: FactoryRunLimits;
|
|
5593
|
+
}
|
|
5594
|
+
/**
|
|
5595
|
+
* Wire-only per-invocation factory resource ceiling overrides.
|
|
5596
|
+
*
|
|
5597
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5598
|
+
* via the `definition` "FactoryRunLimits".
|
|
5599
|
+
*/
|
|
5600
|
+
/** @experimental */
|
|
5601
|
+
export interface FactoryRunLimits {
|
|
4940
5602
|
/**
|
|
4941
|
-
*
|
|
5603
|
+
* Maximum number of factory subagents that may run concurrently.
|
|
4942
5604
|
*/
|
|
4943
|
-
|
|
5605
|
+
maxConcurrentSubagents?: number;
|
|
5606
|
+
/**
|
|
5607
|
+
* Maximum total number of factory subagents that may be admitted.
|
|
5608
|
+
*/
|
|
5609
|
+
maxTotalSubagents?: number;
|
|
5610
|
+
/**
|
|
5611
|
+
* 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.
|
|
5612
|
+
*/
|
|
5613
|
+
timeoutSeconds?: number;
|
|
5614
|
+
/**
|
|
5615
|
+
* 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.
|
|
5616
|
+
*/
|
|
5617
|
+
maxAiCredits?: number;
|
|
5618
|
+
}
|
|
5619
|
+
/**
|
|
5620
|
+
* Resolved persisted factory identity and resumed run envelope.
|
|
5621
|
+
*
|
|
5622
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5623
|
+
* via the `definition` "FactoryResumeResult".
|
|
5624
|
+
*/
|
|
5625
|
+
/** @experimental */
|
|
5626
|
+
export interface FactoryResumeResult {
|
|
5627
|
+
/**
|
|
5628
|
+
* Persisted factory name resolved for the resumed run.
|
|
5629
|
+
*/
|
|
5630
|
+
factoryName: string;
|
|
5631
|
+
run: FactoryRunResult;
|
|
4944
5632
|
}
|
|
4945
5633
|
/**
|
|
4946
5634
|
* Complete current or terminal factory run envelope.
|
|
@@ -4977,6 +5665,71 @@ export interface FactoryRunResult {
|
|
|
4977
5665
|
[k: string]: unknown | undefined;
|
|
4978
5666
|
};
|
|
4979
5667
|
}
|
|
5668
|
+
/**
|
|
5669
|
+
* Full factory run observability detail.
|
|
5670
|
+
*
|
|
5671
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5672
|
+
* via the `definition` "FactoryRunDetail".
|
|
5673
|
+
*/
|
|
5674
|
+
/** @experimental */
|
|
5675
|
+
export interface FactoryRunDetail {
|
|
5676
|
+
runId: string;
|
|
5677
|
+
factoryName: string;
|
|
5678
|
+
description: string;
|
|
5679
|
+
status: FactoryRunStatus;
|
|
5680
|
+
revision: number;
|
|
5681
|
+
createdAt: number;
|
|
5682
|
+
startedAt: number | null;
|
|
5683
|
+
updatedAt: number;
|
|
5684
|
+
completedAt: number | null;
|
|
5685
|
+
currentPhase: FactoryCurrentPhase | null;
|
|
5686
|
+
declaredPhaseCount: number;
|
|
5687
|
+
liveAgentCount: number;
|
|
5688
|
+
totalSpawnedAgentCount: number;
|
|
5689
|
+
consumed: FactoryRunConsumed;
|
|
5690
|
+
declaredLimits: FactoryDeclaredLimits;
|
|
5691
|
+
approved: FactoryDeclaredLimits | null;
|
|
5692
|
+
observedAt: number;
|
|
5693
|
+
activeSegmentStartedAt: number | null;
|
|
5694
|
+
terminal: FactoryRunTerminal | null;
|
|
5695
|
+
phases: FactoryPhaseObservation[];
|
|
5696
|
+
agents: FactoryAgentSummary[];
|
|
5697
|
+
progress: FactoryProgressPage;
|
|
5698
|
+
}
|
|
5699
|
+
/**
|
|
5700
|
+
* Parameters for invoking a registered factory.
|
|
5701
|
+
*
|
|
5702
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5703
|
+
* via the `definition` "FactoryRunRequest".
|
|
5704
|
+
*/
|
|
5705
|
+
/** @experimental */
|
|
5706
|
+
export interface FactoryRunRequest {
|
|
5707
|
+
/**
|
|
5708
|
+
* Registered factory name.
|
|
5709
|
+
*/
|
|
5710
|
+
name: string;
|
|
5711
|
+
/**
|
|
5712
|
+
* Factory input value.
|
|
5713
|
+
*/
|
|
5714
|
+
args: {
|
|
5715
|
+
[k: string]: unknown | undefined;
|
|
5716
|
+
};
|
|
5717
|
+
options?: RunOptions;
|
|
5718
|
+
}
|
|
5719
|
+
/**
|
|
5720
|
+
* Options controlling factory invocation.
|
|
5721
|
+
*
|
|
5722
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5723
|
+
* via the `definition` "RunOptions".
|
|
5724
|
+
*/
|
|
5725
|
+
/** @experimental */
|
|
5726
|
+
export interface RunOptions {
|
|
5727
|
+
limits?: FactoryRunLimits;
|
|
5728
|
+
/**
|
|
5729
|
+
* Run identifier whose journal and progress should seed this resumed run.
|
|
5730
|
+
*/
|
|
5731
|
+
resumeFromRunId?: string;
|
|
5732
|
+
}
|
|
4980
5733
|
/**
|
|
4981
5734
|
* Optional user prompt to combine with the fleet orchestration instructions.
|
|
4982
5735
|
*
|
|
@@ -5251,19 +6004,6 @@ export interface HistoryCompactContextWindow {
|
|
|
5251
6004
|
*/
|
|
5252
6005
|
toolDefinitionsTokens?: number;
|
|
5253
6006
|
}
|
|
5254
|
-
/**
|
|
5255
|
-
* Optional compaction parameters.
|
|
5256
|
-
*
|
|
5257
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5258
|
-
* via the `definition` "HistoryCompactRequest".
|
|
5259
|
-
*/
|
|
5260
|
-
/** @experimental */
|
|
5261
|
-
export interface HistoryCompactRequest {
|
|
5262
|
-
/**
|
|
5263
|
-
* Optional user-provided instructions to focus the compaction summary
|
|
5264
|
-
*/
|
|
5265
|
-
customInstructions?: string;
|
|
5266
|
-
}
|
|
5267
6007
|
/**
|
|
5268
6008
|
* Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown.
|
|
5269
6009
|
*
|
|
@@ -5290,6 +6030,180 @@ export interface HistoryCompactResult {
|
|
|
5290
6030
|
summaryContent?: string;
|
|
5291
6031
|
contextWindow?: HistoryCompactContextWindow;
|
|
5292
6032
|
}
|
|
6033
|
+
/**
|
|
6034
|
+
* Rewind points and file-change-tracking availability for the session.
|
|
6035
|
+
*
|
|
6036
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6037
|
+
* via the `definition` "HistoryListRewindPointsResult".
|
|
6038
|
+
*/
|
|
6039
|
+
/** @experimental */
|
|
6040
|
+
export interface HistoryListRewindPointsResult {
|
|
6041
|
+
/**
|
|
6042
|
+
* Whether this session captured file changes from its first turn.
|
|
6043
|
+
*/
|
|
6044
|
+
fileChangeTrackingEnabled: boolean;
|
|
6045
|
+
unavailableReason?: HistoryRewindUnavailableReason;
|
|
6046
|
+
/**
|
|
6047
|
+
* Root user turns in chronological order. Empty when `unavailableReason` is set.
|
|
6048
|
+
*/
|
|
6049
|
+
points: HistoryRewindPoint[];
|
|
6050
|
+
}
|
|
6051
|
+
/**
|
|
6052
|
+
* A root user turn that the session can rewind to.
|
|
6053
|
+
*
|
|
6054
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6055
|
+
* via the `definition` "HistoryRewindPoint".
|
|
6056
|
+
*/
|
|
6057
|
+
/** @experimental */
|
|
6058
|
+
export interface HistoryRewindPoint {
|
|
6059
|
+
/**
|
|
6060
|
+
* ID of the user.message event that begins the discarded suffix.
|
|
6061
|
+
*/
|
|
6062
|
+
eventId: string;
|
|
6063
|
+
/**
|
|
6064
|
+
* User-visible message text for the turn.
|
|
6065
|
+
*/
|
|
6066
|
+
userMessage: string;
|
|
6067
|
+
/**
|
|
6068
|
+
* ISO timestamp of the user turn.
|
|
6069
|
+
*/
|
|
6070
|
+
timestamp: string;
|
|
6071
|
+
/**
|
|
6072
|
+
* Whether at least one file in this turn or a later turn can be restored.
|
|
6073
|
+
*/
|
|
6074
|
+
canRestoreFiles: boolean;
|
|
6075
|
+
/**
|
|
6076
|
+
* Number of unique files in this turn and all later turns that have captured changes.
|
|
6077
|
+
*/
|
|
6078
|
+
fileCount: number;
|
|
6079
|
+
/**
|
|
6080
|
+
* Whether this turn itself captured any file changes.
|
|
6081
|
+
*/
|
|
6082
|
+
turnChangedFiles: boolean;
|
|
6083
|
+
/**
|
|
6084
|
+
* Lines added by this turn's captured file changes.
|
|
6085
|
+
*/
|
|
6086
|
+
linesAdded: number;
|
|
6087
|
+
/**
|
|
6088
|
+
* Lines removed by this turn's captured file changes.
|
|
6089
|
+
*/
|
|
6090
|
+
linesRemoved: number;
|
|
6091
|
+
/**
|
|
6092
|
+
* Whether this turn was an automatically injected autopilot continuation.
|
|
6093
|
+
*/
|
|
6094
|
+
isAutopilotContinuation: boolean;
|
|
6095
|
+
}
|
|
6096
|
+
/**
|
|
6097
|
+
* Event boundary to preview for conversation-and-files rewind.
|
|
6098
|
+
*
|
|
6099
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6100
|
+
* via the `definition` "HistoryPreviewRewindRequest".
|
|
6101
|
+
*/
|
|
6102
|
+
/** @experimental */
|
|
6103
|
+
export interface HistoryPreviewRewindRequest {
|
|
6104
|
+
/**
|
|
6105
|
+
* ID of the user.message event that begins the discarded suffix.
|
|
6106
|
+
*/
|
|
6107
|
+
eventId: string;
|
|
6108
|
+
}
|
|
6109
|
+
/**
|
|
6110
|
+
* Files and aggregate changes for a prospective rewind.
|
|
6111
|
+
*
|
|
6112
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6113
|
+
* via the `definition` "HistoryPreviewRewindResult".
|
|
6114
|
+
*/
|
|
6115
|
+
/** @experimental */
|
|
6116
|
+
export interface HistoryPreviewRewindResult {
|
|
6117
|
+
/**
|
|
6118
|
+
* Whether file restore is available for this session. This is authoritative: switch on it and read `reason` only when it is false.
|
|
6119
|
+
*/
|
|
6120
|
+
available: boolean;
|
|
6121
|
+
reason?: HistoryRewindUnavailableReason;
|
|
6122
|
+
/**
|
|
6123
|
+
* Number of unique files in the preview.
|
|
6124
|
+
*/
|
|
6125
|
+
fileCount: number;
|
|
6126
|
+
/**
|
|
6127
|
+
* Files ordered by path.
|
|
6128
|
+
*/
|
|
6129
|
+
files: HistoryRewindFilePreview[];
|
|
6130
|
+
}
|
|
6131
|
+
/**
|
|
6132
|
+
* A file that a conversation-and-files rewind would restore.
|
|
6133
|
+
*
|
|
6134
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6135
|
+
* via the `definition` "HistoryRewindFilePreview".
|
|
6136
|
+
*/
|
|
6137
|
+
/** @experimental */
|
|
6138
|
+
export interface HistoryRewindFilePreview {
|
|
6139
|
+
/**
|
|
6140
|
+
* Absolute path of the captured file.
|
|
6141
|
+
*/
|
|
6142
|
+
path: string;
|
|
6143
|
+
changeType: HistoryRewindChangeType;
|
|
6144
|
+
/**
|
|
6145
|
+
* Lines added across the discarded turns.
|
|
6146
|
+
*/
|
|
6147
|
+
linesAdded: number;
|
|
6148
|
+
/**
|
|
6149
|
+
* Lines removed across the discarded turns.
|
|
6150
|
+
*/
|
|
6151
|
+
linesRemoved: number;
|
|
6152
|
+
}
|
|
6153
|
+
/**
|
|
6154
|
+
* Boundary and mode for rewinding session history.
|
|
6155
|
+
*
|
|
6156
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6157
|
+
* via the `definition` "HistoryRewindRequest".
|
|
6158
|
+
*/
|
|
6159
|
+
/** @experimental */
|
|
6160
|
+
export interface HistoryRewindRequest {
|
|
6161
|
+
/**
|
|
6162
|
+
* ID of the user.message event that begins the discarded suffix.
|
|
6163
|
+
*/
|
|
6164
|
+
eventId: string;
|
|
6165
|
+
mode: HistoryRewindMode;
|
|
6166
|
+
}
|
|
6167
|
+
/**
|
|
6168
|
+
* Structured outcome of a rewind request.
|
|
6169
|
+
*
|
|
6170
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6171
|
+
* via the `definition` "HistoryRewindResult".
|
|
6172
|
+
*/
|
|
6173
|
+
/** @experimental */
|
|
6174
|
+
export interface HistoryRewindResult {
|
|
6175
|
+
outcome: HistoryRewindOutcome;
|
|
6176
|
+
/**
|
|
6177
|
+
* 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`.
|
|
6178
|
+
*/
|
|
6179
|
+
eventsRemoved?: number;
|
|
6180
|
+
/**
|
|
6181
|
+
* 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.
|
|
6182
|
+
*/
|
|
6183
|
+
restoredFiles: string[];
|
|
6184
|
+
/**
|
|
6185
|
+
* 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.
|
|
6186
|
+
*/
|
|
6187
|
+
skippedFiles: HistorySkippedFileRestore[];
|
|
6188
|
+
/**
|
|
6189
|
+
* 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`).
|
|
6190
|
+
*/
|
|
6191
|
+
error?: string;
|
|
6192
|
+
}
|
|
6193
|
+
/**
|
|
6194
|
+
* A captured file that rewind intentionally left unchanged.
|
|
6195
|
+
*
|
|
6196
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6197
|
+
* via the `definition` "HistorySkippedFileRestore".
|
|
6198
|
+
*/
|
|
6199
|
+
/** @experimental */
|
|
6200
|
+
export interface HistorySkippedFileRestore {
|
|
6201
|
+
/**
|
|
6202
|
+
* Absolute path of the skipped file.
|
|
6203
|
+
*/
|
|
6204
|
+
path: string;
|
|
6205
|
+
reason: HistoryFileRestoreSkipReason;
|
|
6206
|
+
}
|
|
5293
6207
|
/**
|
|
5294
6208
|
* Markdown summary of the conversation context (empty when not available).
|
|
5295
6209
|
*
|
|
@@ -5328,6 +6242,14 @@ export interface HistoryTruncateResult {
|
|
|
5328
6242
|
* Number of events that were removed
|
|
5329
6243
|
*/
|
|
5330
6244
|
eventsRemoved: number;
|
|
6245
|
+
/**
|
|
6246
|
+
* 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.
|
|
6247
|
+
*/
|
|
6248
|
+
checkpointCleanupFailed?: boolean;
|
|
6249
|
+
/**
|
|
6250
|
+
* Failure detail when checkpointCleanupFailed is true.
|
|
6251
|
+
*/
|
|
6252
|
+
checkpointCleanupError?: string;
|
|
5331
6253
|
}
|
|
5332
6254
|
/**
|
|
5333
6255
|
* Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source.
|
|
@@ -5364,7 +6286,7 @@ export interface InstalledPlugin {
|
|
|
5364
6286
|
source?: InstalledPluginSource;
|
|
5365
6287
|
}
|
|
5366
6288
|
/**
|
|
5367
|
-
* Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, and optional subpath.
|
|
6289
|
+
* Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or full commit SHA, and optional subpath.
|
|
5368
6290
|
*
|
|
5369
6291
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5370
6292
|
* via the `definition` "InstalledPluginSourceGitHub".
|
|
@@ -5377,10 +6299,14 @@ export interface InstalledPluginSourceGitHub {
|
|
|
5377
6299
|
source: "github";
|
|
5378
6300
|
repo: string;
|
|
5379
6301
|
ref?: string;
|
|
6302
|
+
/**
|
|
6303
|
+
* Optional full 40-character hexadecimal commit SHA.
|
|
6304
|
+
*/
|
|
6305
|
+
sha?: string;
|
|
5380
6306
|
path?: string;
|
|
5381
6307
|
}
|
|
5382
6308
|
/**
|
|
5383
|
-
* Source descriptor for a direct URL plugin install, with URL, optional ref, and optional subpath.
|
|
6309
|
+
* Source descriptor for a direct URL plugin install, with URL, optional ref or full commit SHA, and optional subpath.
|
|
5384
6310
|
*
|
|
5385
6311
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5386
6312
|
* via the `definition` "InstalledPluginSourceUrl".
|
|
@@ -5393,6 +6319,10 @@ export interface InstalledPluginSourceUrl {
|
|
|
5393
6319
|
source: "url";
|
|
5394
6320
|
url: string;
|
|
5395
6321
|
ref?: string;
|
|
6322
|
+
/**
|
|
6323
|
+
* Optional full 40-character hexadecimal commit SHA.
|
|
6324
|
+
*/
|
|
6325
|
+
sha?: string;
|
|
5396
6326
|
path?: string;
|
|
5397
6327
|
}
|
|
5398
6328
|
/**
|
|
@@ -5560,10 +6490,36 @@ export interface InstructionSource {
|
|
|
5560
6490
|
*/
|
|
5561
6491
|
defaultDisabled?: boolean;
|
|
5562
6492
|
/**
|
|
5563
|
-
* The project path this source was discovered from. Only set by sessionless discovery for repository
|
|
6493
|
+
* 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.
|
|
5564
6494
|
*/
|
|
5565
6495
|
projectPath?: string;
|
|
5566
6496
|
}
|
|
6497
|
+
/**
|
|
6498
|
+
* Parameters for interrupting the main agent turn.
|
|
6499
|
+
*
|
|
6500
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6501
|
+
* via the `definition` "InterruptMainTurnRequest".
|
|
6502
|
+
*/
|
|
6503
|
+
/** @experimental */
|
|
6504
|
+
export interface InterruptMainTurnRequest {
|
|
6505
|
+
/**
|
|
6506
|
+
* 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.
|
|
6507
|
+
*/
|
|
6508
|
+
flushQueued?: boolean;
|
|
6509
|
+
}
|
|
6510
|
+
/**
|
|
6511
|
+
* Result of interrupting the main agent turn.
|
|
6512
|
+
*
|
|
6513
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6514
|
+
* via the `definition` "InterruptMainTurnResult".
|
|
6515
|
+
*/
|
|
6516
|
+
/** @experimental */
|
|
6517
|
+
export interface InterruptMainTurnResult {
|
|
6518
|
+
/**
|
|
6519
|
+
* Whether an in-flight main agent turn was interrupted. False when the main loop was not processing.
|
|
6520
|
+
*/
|
|
6521
|
+
interrupted: boolean;
|
|
6522
|
+
}
|
|
5567
6523
|
/**
|
|
5568
6524
|
* HTTP headers as a map from lowercased header name to a list of values. Multi-valued headers (e.g. Set-Cookie) preserve all values.
|
|
5569
6525
|
*
|
|
@@ -6389,6 +7345,10 @@ export interface McpServerConfigStdio {
|
|
|
6389
7345
|
oidc?: McpServerAuthConfig;
|
|
6390
7346
|
auth?: McpServerAuthConfig;
|
|
6391
7347
|
deferTools?: McpServerConfigDeferTools;
|
|
7348
|
+
/**
|
|
7349
|
+
* Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery is unaffected.
|
|
7350
|
+
*/
|
|
7351
|
+
disableToolCache?: boolean;
|
|
6392
7352
|
/**
|
|
6393
7353
|
* Executable command used to start the Stdio MCP server process.
|
|
6394
7354
|
*/
|
|
@@ -6446,6 +7406,10 @@ export interface McpServerConfigHttp {
|
|
|
6446
7406
|
oidc?: McpServerAuthConfig;
|
|
6447
7407
|
auth?: McpServerAuthConfig;
|
|
6448
7408
|
deferTools?: McpServerConfigDeferTools;
|
|
7409
|
+
/**
|
|
7410
|
+
* Set to true to disable persisted MCP tool snapshots for this server. Live tool discovery is unaffected.
|
|
7411
|
+
*/
|
|
7412
|
+
disableToolCache?: boolean;
|
|
6449
7413
|
/**
|
|
6450
7414
|
* URL of the remote MCP server endpoint.
|
|
6451
7415
|
*/
|
|
@@ -6644,7 +7608,7 @@ export interface McpExecuteSamplingResult {
|
|
|
6644
7608
|
[k: string]: unknown | undefined;
|
|
6645
7609
|
}
|
|
6646
7610
|
/**
|
|
6647
|
-
* MCP server filtered by policy, with name, reason, optional redacted reason
|
|
7611
|
+
* MCP server filtered by policy, with name, reason, and optional redacted reason.
|
|
6648
7612
|
*
|
|
6649
7613
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6650
7614
|
* via the `definition` "McpFilteredServer".
|
|
@@ -6664,7 +7628,8 @@ export interface McpFilteredServer {
|
|
|
6664
7628
|
*/
|
|
6665
7629
|
redactedReason?: string;
|
|
6666
7630
|
/**
|
|
6667
|
-
*
|
|
7631
|
+
* @deprecated
|
|
7632
|
+
* Deprecated. This field is no longer populated.
|
|
6668
7633
|
*/
|
|
6669
7634
|
enterpriseName?: string;
|
|
6670
7635
|
}
|
|
@@ -6712,7 +7677,7 @@ export interface McpHostState {
|
|
|
6712
7677
|
*/
|
|
6713
7678
|
disabledServers: string[];
|
|
6714
7679
|
/**
|
|
6715
|
-
* Configured servers filtered out by
|
|
7680
|
+
* Configured servers filtered out by MCP server policy.
|
|
6716
7681
|
*/
|
|
6717
7682
|
filteredServers: string[];
|
|
6718
7683
|
/**
|
|
@@ -6931,6 +7896,32 @@ export interface McpOauthLoginResult {
|
|
|
6931
7896
|
*/
|
|
6932
7897
|
authorizationUrl?: string;
|
|
6933
7898
|
}
|
|
7899
|
+
/**
|
|
7900
|
+
* Pending MCP OAuth request id to respond to.
|
|
7901
|
+
*
|
|
7902
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7903
|
+
* via the `definition` "McpOauthRespondRequest".
|
|
7904
|
+
*/
|
|
7905
|
+
/** @experimental */
|
|
7906
|
+
export interface McpOauthRespondRequest {
|
|
7907
|
+
/**
|
|
7908
|
+
* OAuth request identifier from the mcp.oauth_required event
|
|
7909
|
+
*/
|
|
7910
|
+
requestId: string;
|
|
7911
|
+
}
|
|
7912
|
+
/**
|
|
7913
|
+
* Indicates whether the pending MCP OAuth response was accepted.
|
|
7914
|
+
*
|
|
7915
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7916
|
+
* via the `definition` "McpOauthRespondResult".
|
|
7917
|
+
*/
|
|
7918
|
+
/** @experimental */
|
|
7919
|
+
export interface McpOauthRespondResult {
|
|
7920
|
+
/**
|
|
7921
|
+
* Whether the response was accepted. False if the request was unknown, timed out, or already resolved.
|
|
7922
|
+
*/
|
|
7923
|
+
success: boolean;
|
|
7924
|
+
}
|
|
6934
7925
|
/**
|
|
6935
7926
|
* Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove).
|
|
6936
7927
|
*
|
|
@@ -7318,7 +8309,7 @@ export interface McpSetEnvValueModeResult {
|
|
|
7318
8309
|
mode: McpSetEnvValueModeDetails;
|
|
7319
8310
|
}
|
|
7320
8311
|
/**
|
|
7321
|
-
* Server name and configuration for an individual MCP server start.
|
|
8312
|
+
* 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.
|
|
7322
8313
|
*
|
|
7323
8314
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7324
8315
|
* via the `definition` "McpStartServerRequest".
|
|
@@ -7329,7 +8320,7 @@ export interface McpStartServerRequest {
|
|
|
7329
8320
|
* Name of the MCP server to start
|
|
7330
8321
|
*/
|
|
7331
8322
|
serverName: string;
|
|
7332
|
-
config
|
|
8323
|
+
config?: McpServerConfig;
|
|
7333
8324
|
}
|
|
7334
8325
|
/**
|
|
7335
8326
|
* MCP server startup filtering result.
|
|
@@ -7840,7 +8831,7 @@ export interface ModelBillingTokenPricesLongContext {
|
|
|
7840
8831
|
maxPromptTokens?: number;
|
|
7841
8832
|
}
|
|
7842
8833
|
/**
|
|
7843
|
-
* Active server-driven promotion for a model, including its discount and expiry.
|
|
8834
|
+
* Active server-driven promotion for a model, including its discount and optional expiry.
|
|
7844
8835
|
*
|
|
7845
8836
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7846
8837
|
* via the `definition` "ModelBillingPromo".
|
|
@@ -7856,11 +8847,11 @@ export interface ModelBillingPromo {
|
|
|
7856
8847
|
*/
|
|
7857
8848
|
discountPercent?: number;
|
|
7858
8849
|
/**
|
|
7859
|
-
* UTC ISO 8601 timestamp marking when the promotion ends.
|
|
8850
|
+
* 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.
|
|
7860
8851
|
*/
|
|
7861
|
-
endsAt
|
|
8852
|
+
endsAt?: string;
|
|
7862
8853
|
/**
|
|
7863
|
-
* Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it.
|
|
8854
|
+
* Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it when present.
|
|
7864
8855
|
*/
|
|
7865
8856
|
message?: string;
|
|
7866
8857
|
}
|
|
@@ -7950,20 +8941,7 @@ export interface ModelList {
|
|
|
7950
8941
|
models: Model[];
|
|
7951
8942
|
}
|
|
7952
8943
|
/**
|
|
7953
|
-
*
|
|
7954
|
-
*
|
|
7955
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7956
|
-
* via the `definition` "ModelListRequest".
|
|
7957
|
-
*/
|
|
7958
|
-
/** @experimental */
|
|
7959
|
-
export interface ModelListRequest {
|
|
7960
|
-
/**
|
|
7961
|
-
* If true, bypasses the per-session model list cache and re-fetches from CAPI.
|
|
7962
|
-
*/
|
|
7963
|
-
skipCache?: boolean;
|
|
7964
|
-
}
|
|
7965
|
-
/**
|
|
7966
|
-
* Reasoning effort level to apply to the currently selected model.
|
|
8944
|
+
* Reasoning effort level to apply to the currently selected model.
|
|
7967
8945
|
*
|
|
7968
8946
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7969
8947
|
* via the `definition` "ModelSetReasoningEffortRequest".
|
|
@@ -8015,6 +8993,10 @@ export interface ModelSwitchToRequest {
|
|
|
8015
8993
|
verbosity?: Verbosity;
|
|
8016
8994
|
modelCapabilities?: ModelCapabilitiesOverride;
|
|
8017
8995
|
contextTier?: ContextTier;
|
|
8996
|
+
/**
|
|
8997
|
+
* 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).
|
|
8998
|
+
*/
|
|
8999
|
+
deferIfModelChangeQueued?: boolean;
|
|
8018
9000
|
}
|
|
8019
9001
|
/**
|
|
8020
9002
|
* The model identifier active on the session after the switch.
|
|
@@ -8028,6 +9010,10 @@ export interface ModelSwitchToResult {
|
|
|
8028
9010
|
* Currently active model identifier after the switch
|
|
8029
9011
|
*/
|
|
8030
9012
|
modelId?: string;
|
|
9013
|
+
/**
|
|
9014
|
+
* 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.
|
|
9015
|
+
*/
|
|
9016
|
+
deferred?: boolean;
|
|
8031
9017
|
}
|
|
8032
9018
|
/**
|
|
8033
9019
|
* Agent interaction mode to apply to the session.
|
|
@@ -8218,6 +9204,10 @@ export interface PermissionDecisionApproveOnce {
|
|
|
8218
9204
|
* Approve this single request only
|
|
8219
9205
|
*/
|
|
8220
9206
|
kind: "approve-once";
|
|
9207
|
+
/**
|
|
9208
|
+
* True only when a host surfaced this request to a user who approved it.
|
|
9209
|
+
*/
|
|
9210
|
+
approvedInteractively?: boolean;
|
|
8221
9211
|
}
|
|
8222
9212
|
/**
|
|
8223
9213
|
* Permission-decision request variant to approve for the rest of the session, with optional tool approval or URL domain.
|
|
@@ -9371,13 +10361,17 @@ export interface PermissionsPathsUpdatePrimaryResult {
|
|
|
9371
10361
|
export interface PermissionsPendingRequestsRequest {
|
|
9372
10362
|
}
|
|
9373
10363
|
/**
|
|
9374
|
-
*
|
|
10364
|
+
* Clears session-scoped tool permission approvals, and optionally the location-scoped ones.
|
|
9375
10365
|
*
|
|
9376
10366
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9377
10367
|
* via the `definition` "PermissionsResetSessionApprovalsRequest".
|
|
9378
10368
|
*/
|
|
9379
10369
|
/** @experimental */
|
|
9380
10370
|
export interface PermissionsResetSessionApprovalsRequest {
|
|
10371
|
+
/**
|
|
10372
|
+
* Whether location-scoped approvals are cleared too. Defaults to `true`.
|
|
10373
|
+
*/
|
|
10374
|
+
includeLocation?: boolean;
|
|
9381
10375
|
}
|
|
9382
10376
|
/**
|
|
9383
10377
|
* Indicates whether the operation succeeded.
|
|
@@ -9800,35 +10794,6 @@ export interface PluginsMarketplacesRemoveRequest {
|
|
|
9800
10794
|
*/
|
|
9801
10795
|
force?: boolean;
|
|
9802
10796
|
}
|
|
9803
|
-
/**
|
|
9804
|
-
* Optional flags controlling which side effects the reload performs.
|
|
9805
|
-
*
|
|
9806
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9807
|
-
* via the `definition` "PluginsReloadRequest".
|
|
9808
|
-
*/
|
|
9809
|
-
/** @experimental */
|
|
9810
|
-
export interface PluginsReloadRequest {
|
|
9811
|
-
/**
|
|
9812
|
-
* Reload MCP server connections after refreshing plugins. Defaults to true.
|
|
9813
|
-
*/
|
|
9814
|
-
reloadMcp?: boolean;
|
|
9815
|
-
/**
|
|
9816
|
-
* Re-run custom-agent discovery after refreshing plugins. Defaults to true.
|
|
9817
|
-
*/
|
|
9818
|
-
reloadCustomAgents?: boolean;
|
|
9819
|
-
/**
|
|
9820
|
-
* 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).
|
|
9821
|
-
*/
|
|
9822
|
-
reloadHooks?: boolean;
|
|
9823
|
-
/**
|
|
9824
|
-
* 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).
|
|
9825
|
-
*/
|
|
9826
|
-
reloadExtensions?: boolean;
|
|
9827
|
-
/**
|
|
9828
|
-
* When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`.
|
|
9829
|
-
*/
|
|
9830
|
-
deferRepoHooks?: boolean;
|
|
9831
|
-
}
|
|
9832
10797
|
/**
|
|
9833
10798
|
* Name (or spec) of the plugin to uninstall.
|
|
9834
10799
|
*
|
|
@@ -10109,19 +11074,6 @@ export interface ProviderSessionToken {
|
|
|
10109
11074
|
*/
|
|
10110
11075
|
expiresAt?: string;
|
|
10111
11076
|
}
|
|
10112
|
-
/**
|
|
10113
|
-
* Optional model identifier to scope the endpoint snapshot to.
|
|
10114
|
-
*
|
|
10115
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10116
|
-
* via the `definition` "ProviderGetEndpointRequest".
|
|
10117
|
-
*/
|
|
10118
|
-
/** @experimental */
|
|
10119
|
-
export interface ProviderGetEndpointRequest {
|
|
10120
|
-
/**
|
|
10121
|
-
* 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.
|
|
10122
|
-
*/
|
|
10123
|
-
modelId?: string;
|
|
10124
|
-
}
|
|
10125
11077
|
/**
|
|
10126
11078
|
* 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.
|
|
10127
11079
|
*
|
|
@@ -10611,6 +11563,253 @@ export interface PushAttachmentBlob {
|
|
|
10611
11563
|
*/
|
|
10612
11564
|
displayName?: string;
|
|
10613
11565
|
}
|
|
11566
|
+
/**
|
|
11567
|
+
* Inputs for starting a deferred-idle drain.
|
|
11568
|
+
*
|
|
11569
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11570
|
+
* via the `definition` "QueueBeginDeferredIdleDrainRequest".
|
|
11571
|
+
*/
|
|
11572
|
+
/** @experimental */
|
|
11573
|
+
export interface QueueBeginDeferredIdleDrainRequest {
|
|
11574
|
+
/**
|
|
11575
|
+
* Whether the host still has active background work.
|
|
11576
|
+
*/
|
|
11577
|
+
activeBackgroundWork: boolean;
|
|
11578
|
+
}
|
|
11579
|
+
/**
|
|
11580
|
+
* Whether a deferred-idle drain should run.
|
|
11581
|
+
*
|
|
11582
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11583
|
+
* via the `definition` "QueueBeginDeferredIdleDrainResult".
|
|
11584
|
+
*/
|
|
11585
|
+
/** @experimental */
|
|
11586
|
+
export interface QueueBeginDeferredIdleDrainResult {
|
|
11587
|
+
/**
|
|
11588
|
+
* True when the host should run finishDeferredIdleDrain asynchronously.
|
|
11589
|
+
*/
|
|
11590
|
+
shouldDrain: boolean;
|
|
11591
|
+
}
|
|
11592
|
+
/**
|
|
11593
|
+
* Internal filter for consuming queued system notifications.
|
|
11594
|
+
*
|
|
11595
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11596
|
+
* via the `definition` "QueueConsumeSystemNotificationsRequest".
|
|
11597
|
+
*/
|
|
11598
|
+
/** @experimental */
|
|
11599
|
+
export interface QueueConsumeSystemNotificationsRequest {
|
|
11600
|
+
/**
|
|
11601
|
+
* Opaque runtime-owned filter object.
|
|
11602
|
+
*/
|
|
11603
|
+
filter: {
|
|
11604
|
+
[k: string]: unknown | undefined;
|
|
11605
|
+
};
|
|
11606
|
+
}
|
|
11607
|
+
/**
|
|
11608
|
+
* Inputs for marking session.idle deferred in native state.
|
|
11609
|
+
*
|
|
11610
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11611
|
+
* via the `definition` "QueueDeferSessionIdleRequest".
|
|
11612
|
+
*/
|
|
11613
|
+
/** @experimental */
|
|
11614
|
+
export interface QueueDeferSessionIdleRequest {
|
|
11615
|
+
/**
|
|
11616
|
+
* Whether the deferred idle was caused by an aborted foreground turn.
|
|
11617
|
+
*/
|
|
11618
|
+
aborted: boolean;
|
|
11619
|
+
}
|
|
11620
|
+
/**
|
|
11621
|
+
* Parameters for duplicating a queued item.
|
|
11622
|
+
*
|
|
11623
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11624
|
+
* via the `definition` "QueueDuplicateAtRequest".
|
|
11625
|
+
*/
|
|
11626
|
+
/** @experimental */
|
|
11627
|
+
export interface QueueDuplicateAtRequest {
|
|
11628
|
+
id: string;
|
|
11629
|
+
}
|
|
11630
|
+
/**
|
|
11631
|
+
* Result of duplicating a queued item.
|
|
11632
|
+
*
|
|
11633
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11634
|
+
* via the `definition` "QueueDuplicateAtResult".
|
|
11635
|
+
*/
|
|
11636
|
+
/** @experimental */
|
|
11637
|
+
export interface QueueDuplicateAtResult {
|
|
11638
|
+
/**
|
|
11639
|
+
* Fresh stable opaque id assigned to the duplicate.
|
|
11640
|
+
*/
|
|
11641
|
+
id: string;
|
|
11642
|
+
}
|
|
11643
|
+
/**
|
|
11644
|
+
* Result of enqueueing the resume-pending wake item.
|
|
11645
|
+
*
|
|
11646
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11647
|
+
* via the `definition` "QueueEnqueueResumePendingResult".
|
|
11648
|
+
*/
|
|
11649
|
+
/** @experimental */
|
|
11650
|
+
export interface QueueEnqueueResumePendingResult {
|
|
11651
|
+
/**
|
|
11652
|
+
* True when a wake item was newly queued.
|
|
11653
|
+
*/
|
|
11654
|
+
queued: boolean;
|
|
11655
|
+
}
|
|
11656
|
+
/**
|
|
11657
|
+
* Inputs for completing a deferred-idle drain.
|
|
11658
|
+
*
|
|
11659
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11660
|
+
* via the `definition` "QueueFinishDeferredIdleDrainRequest".
|
|
11661
|
+
*/
|
|
11662
|
+
/** @experimental */
|
|
11663
|
+
export interface QueueFinishDeferredIdleDrainRequest {
|
|
11664
|
+
/**
|
|
11665
|
+
* Whether the host still has active background work.
|
|
11666
|
+
*/
|
|
11667
|
+
activeBackgroundWork: boolean;
|
|
11668
|
+
/**
|
|
11669
|
+
* Whether native queued work remains.
|
|
11670
|
+
*/
|
|
11671
|
+
hasPending: boolean;
|
|
11672
|
+
}
|
|
11673
|
+
/**
|
|
11674
|
+
* Action selected by the native deferred-idle drain.
|
|
11675
|
+
*
|
|
11676
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11677
|
+
* via the `definition` "QueueFinishDeferredIdleDrainResult".
|
|
11678
|
+
*/
|
|
11679
|
+
/** @experimental */
|
|
11680
|
+
export interface QueueFinishDeferredIdleDrainResult {
|
|
11681
|
+
/**
|
|
11682
|
+
* One of none, processQueue, or emitSessionIdle.
|
|
11683
|
+
*/
|
|
11684
|
+
action: string;
|
|
11685
|
+
/**
|
|
11686
|
+
* Whether the deferred idle was caused by an aborted foreground turn.
|
|
11687
|
+
*/
|
|
11688
|
+
aborted: boolean;
|
|
11689
|
+
}
|
|
11690
|
+
/**
|
|
11691
|
+
* Whether the native queue has pending work.
|
|
11692
|
+
*
|
|
11693
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11694
|
+
* via the `definition` "QueueHasPendingResult".
|
|
11695
|
+
*/
|
|
11696
|
+
/** @experimental */
|
|
11697
|
+
export interface QueueHasPendingResult {
|
|
11698
|
+
/**
|
|
11699
|
+
* True when queued or immediate native work is pending.
|
|
11700
|
+
*/
|
|
11701
|
+
hasPending: boolean;
|
|
11702
|
+
}
|
|
11703
|
+
/**
|
|
11704
|
+
* Parameters for inserting a queued message at a public visible position.
|
|
11705
|
+
*
|
|
11706
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11707
|
+
* via the `definition` "QueueInsertAtRequest".
|
|
11708
|
+
*/
|
|
11709
|
+
/** @experimental */
|
|
11710
|
+
export interface QueueInsertAtRequest {
|
|
11711
|
+
/**
|
|
11712
|
+
* Zero-based position in the public visible queue. Values outside the queue clamp to an end.
|
|
11713
|
+
*/
|
|
11714
|
+
position: number;
|
|
11715
|
+
message: QueueInsertMessage;
|
|
11716
|
+
}
|
|
11717
|
+
/**
|
|
11718
|
+
* Serializable message fields accepted by queue.insertAt.
|
|
11719
|
+
*
|
|
11720
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11721
|
+
* via the `definition` "QueueInsertMessage".
|
|
11722
|
+
*/
|
|
11723
|
+
/** @experimental */
|
|
11724
|
+
export interface QueueInsertMessage {
|
|
11725
|
+
/**
|
|
11726
|
+
* The user message text.
|
|
11727
|
+
*/
|
|
11728
|
+
prompt: string;
|
|
11729
|
+
/**
|
|
11730
|
+
* Optional user-facing display text.
|
|
11731
|
+
*/
|
|
11732
|
+
displayPrompt?: string;
|
|
11733
|
+
/**
|
|
11734
|
+
* Optional attachments for the message.
|
|
11735
|
+
*/
|
|
11736
|
+
attachments?: Attachment[];
|
|
11737
|
+
agentMode?: SendAgentMode;
|
|
11738
|
+
/**
|
|
11739
|
+
* 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.
|
|
11740
|
+
*/
|
|
11741
|
+
source?: string;
|
|
11742
|
+
/**
|
|
11743
|
+
* Whether the message is billable.
|
|
11744
|
+
*/
|
|
11745
|
+
billable?: boolean;
|
|
11746
|
+
/**
|
|
11747
|
+
* Required tool name for the turn, when any.
|
|
11748
|
+
*/
|
|
11749
|
+
requiredTool?: string;
|
|
11750
|
+
/**
|
|
11751
|
+
* Per-turn request headers.
|
|
11752
|
+
*/
|
|
11753
|
+
requestHeaders?: {
|
|
11754
|
+
[k: string]: string | undefined;
|
|
11755
|
+
};
|
|
11756
|
+
mode?: SendMode;
|
|
11757
|
+
/**
|
|
11758
|
+
* Accepted for SendOptions compatibility but ignored; the requested public position controls placement.
|
|
11759
|
+
*/
|
|
11760
|
+
prepend?: boolean;
|
|
11761
|
+
/**
|
|
11762
|
+
* Accepted for SendOptions compatibility but ignored; insertion scheduling is controlled by the queue drain state.
|
|
11763
|
+
*/
|
|
11764
|
+
wait?: boolean;
|
|
11765
|
+
/**
|
|
11766
|
+
* Accepted for internal SendOptions compatibility but ignored; delivery is derived from current session activity.
|
|
11767
|
+
*/
|
|
11768
|
+
delivery?: string;
|
|
11769
|
+
}
|
|
11770
|
+
/**
|
|
11771
|
+
* Result of inserting a queued message.
|
|
11772
|
+
*
|
|
11773
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11774
|
+
* via the `definition` "QueueInsertAtResult".
|
|
11775
|
+
*/
|
|
11776
|
+
/** @experimental */
|
|
11777
|
+
export interface QueueInsertAtResult {
|
|
11778
|
+
/**
|
|
11779
|
+
* Fresh stable opaque id assigned to the inserted item.
|
|
11780
|
+
*/
|
|
11781
|
+
id: string;
|
|
11782
|
+
}
|
|
11783
|
+
/**
|
|
11784
|
+
* Parameters for moving a queued item by stable id.
|
|
11785
|
+
*
|
|
11786
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11787
|
+
* via the `definition` "QueueMoveItemRequest".
|
|
11788
|
+
*/
|
|
11789
|
+
/** @experimental */
|
|
11790
|
+
export interface QueueMoveItemRequest {
|
|
11791
|
+
/**
|
|
11792
|
+
* Stable opaque queued-item id.
|
|
11793
|
+
*/
|
|
11794
|
+
id: string;
|
|
11795
|
+
/**
|
|
11796
|
+
* Zero-based target position in the public visible queue. Values outside the queue clamp to an end.
|
|
11797
|
+
*/
|
|
11798
|
+
toPosition: number;
|
|
11799
|
+
}
|
|
11800
|
+
/**
|
|
11801
|
+
* Result of moving a queued item.
|
|
11802
|
+
*
|
|
11803
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11804
|
+
* via the `definition` "QueueMoveItemResult".
|
|
11805
|
+
*/
|
|
11806
|
+
/** @experimental */
|
|
11807
|
+
export interface QueueMoveItemResult {
|
|
11808
|
+
/**
|
|
11809
|
+
* True when the item changed position; false when it was already at the requested position.
|
|
11810
|
+
*/
|
|
11811
|
+
changed: boolean;
|
|
11812
|
+
}
|
|
10614
11813
|
/**
|
|
10615
11814
|
* User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change.
|
|
10616
11815
|
*
|
|
@@ -10619,11 +11818,16 @@ export interface PushAttachmentBlob {
|
|
|
10619
11818
|
*/
|
|
10620
11819
|
/** @experimental */
|
|
10621
11820
|
export interface QueuePendingItems {
|
|
11821
|
+
/**
|
|
11822
|
+
* Stable opaque id for the canonical queued item. Batch rows share one id.
|
|
11823
|
+
*/
|
|
11824
|
+
id: string;
|
|
10622
11825
|
kind: QueuePendingItemsKind;
|
|
10623
11826
|
/**
|
|
10624
11827
|
* Human-readable text to display for this queue entry in the UI
|
|
10625
11828
|
*/
|
|
10626
11829
|
displayText: string;
|
|
11830
|
+
agentMode: SendAgentMode;
|
|
10627
11831
|
}
|
|
10628
11832
|
/**
|
|
10629
11833
|
* Snapshot of the session's pending queued items and immediate-steering messages.
|
|
@@ -10642,6 +11846,29 @@ export interface QueuePendingItemsResult {
|
|
|
10642
11846
|
*/
|
|
10643
11847
|
steeringMessages: string[];
|
|
10644
11848
|
}
|
|
11849
|
+
/**
|
|
11850
|
+
* Parameters for removing a queued item by stable id.
|
|
11851
|
+
*
|
|
11852
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11853
|
+
* via the `definition` "QueueRemoveAtRequest".
|
|
11854
|
+
*/
|
|
11855
|
+
/** @experimental */
|
|
11856
|
+
export interface QueueRemoveAtRequest {
|
|
11857
|
+
id: string;
|
|
11858
|
+
}
|
|
11859
|
+
/**
|
|
11860
|
+
* Result of removing a queued item.
|
|
11861
|
+
*
|
|
11862
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11863
|
+
* via the `definition` "QueueRemoveAtResult".
|
|
11864
|
+
*/
|
|
11865
|
+
/** @experimental */
|
|
11866
|
+
export interface QueueRemoveAtResult {
|
|
11867
|
+
/**
|
|
11868
|
+
* True when the addressed item was removed.
|
|
11869
|
+
*/
|
|
11870
|
+
removed: boolean;
|
|
11871
|
+
}
|
|
10645
11872
|
/**
|
|
10646
11873
|
* Indicates whether a user-facing pending item was removed.
|
|
10647
11874
|
*
|
|
@@ -10655,6 +11882,89 @@ export interface QueueRemoveMostRecentResult {
|
|
|
10655
11882
|
*/
|
|
10656
11883
|
removed: boolean;
|
|
10657
11884
|
}
|
|
11885
|
+
/**
|
|
11886
|
+
* Parameters for steering a queued message into a live turn.
|
|
11887
|
+
*
|
|
11888
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11889
|
+
* via the `definition` "QueueSendNowRequest".
|
|
11890
|
+
*/
|
|
11891
|
+
/** @experimental */
|
|
11892
|
+
export interface QueueSendNowRequest {
|
|
11893
|
+
id: string;
|
|
11894
|
+
}
|
|
11895
|
+
/**
|
|
11896
|
+
* Result of trying to steer a queued message into a live turn.
|
|
11897
|
+
*
|
|
11898
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11899
|
+
* via the `definition` "QueueSendNowResult".
|
|
11900
|
+
*/
|
|
11901
|
+
/** @experimental */
|
|
11902
|
+
export interface QueueSendNowResult {
|
|
11903
|
+
/**
|
|
11904
|
+
* True when the item was accepted into the steering lane; false when no main turn was live.
|
|
11905
|
+
*/
|
|
11906
|
+
steered: boolean;
|
|
11907
|
+
}
|
|
11908
|
+
/**
|
|
11909
|
+
* 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.
|
|
11910
|
+
*
|
|
11911
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11912
|
+
* via the `definition` "QueueSetDrainPausedRequest".
|
|
11913
|
+
*/
|
|
11914
|
+
/** @experimental */
|
|
11915
|
+
export interface QueueSetDrainPausedRequest {
|
|
11916
|
+
paused: boolean;
|
|
11917
|
+
}
|
|
11918
|
+
/**
|
|
11919
|
+
* Internal snapshot of native queue state for local session orchestration.
|
|
11920
|
+
*
|
|
11921
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11922
|
+
* via the `definition` "QueueSnapshotResult".
|
|
11923
|
+
*/
|
|
11924
|
+
/** @experimental */
|
|
11925
|
+
export interface QueueSnapshotResult {
|
|
11926
|
+
/**
|
|
11927
|
+
* User-facing pending items in FIFO order.
|
|
11928
|
+
*/
|
|
11929
|
+
items: QueuePendingItems[];
|
|
11930
|
+
/**
|
|
11931
|
+
* Immediate steering messages waiting for an active turn.
|
|
11932
|
+
*/
|
|
11933
|
+
steeringMessages: string[];
|
|
11934
|
+
/**
|
|
11935
|
+
* Insertion orders for queued items, aligned with `items`.
|
|
11936
|
+
*/
|
|
11937
|
+
itemOrders?: number[];
|
|
11938
|
+
/**
|
|
11939
|
+
* Insertion orders for immediate steering messages, aligned with `steeringMessages`.
|
|
11940
|
+
*/
|
|
11941
|
+
steeringMessageOrders?: number[];
|
|
11942
|
+
}
|
|
11943
|
+
/**
|
|
11944
|
+
* Parameters for editing a single queued message.
|
|
11945
|
+
*
|
|
11946
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11947
|
+
* via the `definition` "QueueUpdateTextRequest".
|
|
11948
|
+
*/
|
|
11949
|
+
/** @experimental */
|
|
11950
|
+
export interface QueueUpdateTextRequest {
|
|
11951
|
+
id: string;
|
|
11952
|
+
prompt: string;
|
|
11953
|
+
displayPrompt?: string;
|
|
11954
|
+
}
|
|
11955
|
+
/**
|
|
11956
|
+
* Result of editing a queued message.
|
|
11957
|
+
*
|
|
11958
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11959
|
+
* via the `definition` "QueueUpdateTextResult".
|
|
11960
|
+
*/
|
|
11961
|
+
/** @experimental */
|
|
11962
|
+
export interface QueueUpdateTextResult {
|
|
11963
|
+
/**
|
|
11964
|
+
* True when the stored text changed.
|
|
11965
|
+
*/
|
|
11966
|
+
updated: boolean;
|
|
11967
|
+
}
|
|
10658
11968
|
/**
|
|
10659
11969
|
* Event type to register consumer interest for, used by runtime gating logic.
|
|
10660
11970
|
*
|
|
@@ -11105,6 +12415,28 @@ export interface SandboxConfigUserPolicyNetwork {
|
|
|
11105
12415
|
* Whether traffic to local/loopback addresses is allowed.
|
|
11106
12416
|
*/
|
|
11107
12417
|
allowLocalNetwork?: boolean;
|
|
12418
|
+
proxy?: SandboxConfigUserPolicyNetworkProxy;
|
|
12419
|
+
}
|
|
12420
|
+
/**
|
|
12421
|
+
* HTTP proxy configuration for sandboxed traffic.
|
|
12422
|
+
*
|
|
12423
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12424
|
+
* via the `definition` "SandboxConfigUserPolicyNetworkProxy".
|
|
12425
|
+
*/
|
|
12426
|
+
/** @experimental */
|
|
12427
|
+
export interface SandboxConfigUserPolicyNetworkProxy {
|
|
12428
|
+
/**
|
|
12429
|
+
* 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.
|
|
12430
|
+
*/
|
|
12431
|
+
url: string;
|
|
12432
|
+
/**
|
|
12433
|
+
* Optional username for proxy authentication. Combined with the URL (and `password`) into `user:pass@host` when the sandboxed process routes through the proxy.
|
|
12434
|
+
*/
|
|
12435
|
+
username?: string;
|
|
12436
|
+
/**
|
|
12437
|
+
* 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.
|
|
12438
|
+
*/
|
|
12439
|
+
password?: string;
|
|
11108
12440
|
}
|
|
11109
12441
|
/**
|
|
11110
12442
|
* macOS seatbelt-specific options.
|
|
@@ -11130,17 +12462,110 @@ export interface SandboxConfigUserPolicyExperimental {
|
|
|
11130
12462
|
seatbelt?: SandboxConfigUserPolicyExperimentalSeatbelt;
|
|
11131
12463
|
}
|
|
11132
12464
|
/**
|
|
11133
|
-
* macOS seatbelt experimental options.
|
|
12465
|
+
* macOS seatbelt experimental options.
|
|
12466
|
+
*
|
|
12467
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12468
|
+
* via the `definition` "SandboxConfigUserPolicyExperimentalSeatbelt".
|
|
12469
|
+
*/
|
|
12470
|
+
/** @experimental */
|
|
12471
|
+
export interface SandboxConfigUserPolicyExperimentalSeatbelt {
|
|
12472
|
+
/**
|
|
12473
|
+
* Whether the macOS seatbelt profile may access the keychain.
|
|
12474
|
+
*/
|
|
12475
|
+
keychainAccess?: boolean;
|
|
12476
|
+
}
|
|
12477
|
+
/**
|
|
12478
|
+
* Register an absolute-time scheduled prompt.
|
|
12479
|
+
*
|
|
12480
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12481
|
+
* via the `definition` "ScheduleAddAtRequest".
|
|
12482
|
+
*/
|
|
12483
|
+
/** @experimental */
|
|
12484
|
+
export interface ScheduleAddAtRequest {
|
|
12485
|
+
/**
|
|
12486
|
+
* Epoch milliseconds when the prompt should fire.
|
|
12487
|
+
*/
|
|
12488
|
+
at: number;
|
|
12489
|
+
/**
|
|
12490
|
+
* Prompt text to enqueue when the schedule fires.
|
|
12491
|
+
*/
|
|
12492
|
+
prompt: string;
|
|
12493
|
+
/**
|
|
12494
|
+
* Whether the schedule should re-arm after each tick. Defaults to false.
|
|
12495
|
+
*/
|
|
12496
|
+
recurring?: boolean;
|
|
12497
|
+
/**
|
|
12498
|
+
* Optional display-only prompt label.
|
|
12499
|
+
*/
|
|
12500
|
+
displayPrompt?: string;
|
|
12501
|
+
}
|
|
12502
|
+
/**
|
|
12503
|
+
* Register a cron scheduled prompt.
|
|
12504
|
+
*
|
|
12505
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12506
|
+
* via the `definition` "ScheduleAddCronRequest".
|
|
12507
|
+
*/
|
|
12508
|
+
/** @experimental */
|
|
12509
|
+
export interface ScheduleAddCronRequest {
|
|
12510
|
+
/**
|
|
12511
|
+
* 5-field cron expression.
|
|
12512
|
+
*/
|
|
12513
|
+
cron: string;
|
|
12514
|
+
/**
|
|
12515
|
+
* Prompt text to enqueue when the schedule fires.
|
|
12516
|
+
*/
|
|
12517
|
+
prompt: string;
|
|
12518
|
+
/**
|
|
12519
|
+
* Whether the schedule should re-arm after each tick. Defaults to true.
|
|
12520
|
+
*/
|
|
12521
|
+
recurring?: boolean;
|
|
12522
|
+
/**
|
|
12523
|
+
* Optional display-only prompt label.
|
|
12524
|
+
*/
|
|
12525
|
+
displayPrompt?: string;
|
|
12526
|
+
/**
|
|
12527
|
+
* IANA timezone for evaluating the cron expression.
|
|
12528
|
+
*/
|
|
12529
|
+
tz?: string;
|
|
12530
|
+
}
|
|
12531
|
+
/**
|
|
12532
|
+
* Register a relative-interval scheduled prompt.
|
|
12533
|
+
*
|
|
12534
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12535
|
+
* via the `definition` "ScheduleAddRequest".
|
|
12536
|
+
*/
|
|
12537
|
+
/** @experimental */
|
|
12538
|
+
export interface ScheduleAddRequest {
|
|
12539
|
+
/**
|
|
12540
|
+
* Human-readable interval such as `30s`, `5m`, or `2h`.
|
|
12541
|
+
*/
|
|
12542
|
+
interval: string;
|
|
12543
|
+
/**
|
|
12544
|
+
* Prompt text to enqueue when the schedule fires.
|
|
12545
|
+
*/
|
|
12546
|
+
prompt: string;
|
|
12547
|
+
/**
|
|
12548
|
+
* Whether the schedule should re-arm after each tick. Defaults to true.
|
|
12549
|
+
*/
|
|
12550
|
+
recurring?: boolean;
|
|
12551
|
+
/**
|
|
12552
|
+
* Optional display-only prompt label.
|
|
12553
|
+
*/
|
|
12554
|
+
displayPrompt?: string;
|
|
12555
|
+
}
|
|
12556
|
+
/**
|
|
12557
|
+
* Result of registering or re-arming a scheduled prompt.
|
|
11134
12558
|
*
|
|
11135
12559
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11136
|
-
* via the `definition` "
|
|
12560
|
+
* via the `definition` "ScheduleAddResult".
|
|
11137
12561
|
*/
|
|
11138
12562
|
/** @experimental */
|
|
11139
|
-
export interface
|
|
12563
|
+
export interface ScheduleAddResult {
|
|
12564
|
+
entry?: ScheduleEntry;
|
|
11140
12565
|
/**
|
|
11141
|
-
*
|
|
12566
|
+
* User-facing validation error, when registration failed.
|
|
11142
12567
|
*/
|
|
11143
|
-
|
|
12568
|
+
error?: string;
|
|
11144
12569
|
}
|
|
11145
12570
|
/**
|
|
11146
12571
|
* Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time.
|
|
@@ -11191,6 +12616,36 @@ export interface ScheduleEntry {
|
|
|
11191
12616
|
*/
|
|
11192
12617
|
nextRunAt: string;
|
|
11193
12618
|
}
|
|
12619
|
+
/**
|
|
12620
|
+
* Register a self-paced scheduled prompt.
|
|
12621
|
+
*
|
|
12622
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12623
|
+
* via the `definition` "ScheduleAddSelfPacedRequest".
|
|
12624
|
+
*/
|
|
12625
|
+
/** @experimental */
|
|
12626
|
+
export interface ScheduleAddSelfPacedRequest {
|
|
12627
|
+
/**
|
|
12628
|
+
* Prompt text to enqueue when the schedule fires.
|
|
12629
|
+
*/
|
|
12630
|
+
prompt: string;
|
|
12631
|
+
/**
|
|
12632
|
+
* Optional display-only prompt label.
|
|
12633
|
+
*/
|
|
12634
|
+
displayPrompt?: string;
|
|
12635
|
+
}
|
|
12636
|
+
/**
|
|
12637
|
+
* Whether the session currently has an active self-paced schedule.
|
|
12638
|
+
*
|
|
12639
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12640
|
+
* via the `definition` "ScheduleHasSelfPacedResult".
|
|
12641
|
+
*/
|
|
12642
|
+
/** @experimental */
|
|
12643
|
+
export interface ScheduleHasSelfPacedResult {
|
|
12644
|
+
/**
|
|
12645
|
+
* True when at least one active schedule is self-paced.
|
|
12646
|
+
*/
|
|
12647
|
+
hasSelfPaced: boolean;
|
|
12648
|
+
}
|
|
11194
12649
|
/**
|
|
11195
12650
|
* Snapshot of the currently active recurring prompts for this session.
|
|
11196
12651
|
*
|
|
@@ -11204,6 +12659,23 @@ export interface ScheduleList {
|
|
|
11204
12659
|
*/
|
|
11205
12660
|
entries: ScheduleEntry[];
|
|
11206
12661
|
}
|
|
12662
|
+
/**
|
|
12663
|
+
* Re-arm a self-paced scheduled prompt.
|
|
12664
|
+
*
|
|
12665
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12666
|
+
* via the `definition` "ScheduleRearmSelfPacedRequest".
|
|
12667
|
+
*/
|
|
12668
|
+
/** @experimental */
|
|
12669
|
+
export interface ScheduleRearmSelfPacedRequest {
|
|
12670
|
+
/**
|
|
12671
|
+
* Id of the self-paced scheduled prompt.
|
|
12672
|
+
*/
|
|
12673
|
+
id: number;
|
|
12674
|
+
/**
|
|
12675
|
+
* Epoch milliseconds when the prompt should next fire.
|
|
12676
|
+
*/
|
|
12677
|
+
at: number;
|
|
12678
|
+
}
|
|
11207
12679
|
/**
|
|
11208
12680
|
* Identifier of the scheduled prompt to remove.
|
|
11209
12681
|
*
|
|
@@ -11328,7 +12800,7 @@ export interface SendMessagesRequest {
|
|
|
11328
12800
|
*/
|
|
11329
12801
|
tracestate?: string;
|
|
11330
12802
|
/**
|
|
11331
|
-
* 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.
|
|
12803
|
+
* 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.
|
|
11332
12804
|
*/
|
|
11333
12805
|
wait?: boolean;
|
|
11334
12806
|
}
|
|
@@ -11394,7 +12866,7 @@ export interface SendRequest {
|
|
|
11394
12866
|
*/
|
|
11395
12867
|
tracestate?: string;
|
|
11396
12868
|
/**
|
|
11397
|
-
* 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.
|
|
12869
|
+
* 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.
|
|
11398
12870
|
*/
|
|
11399
12871
|
wait?: boolean;
|
|
11400
12872
|
}
|
|
@@ -11411,6 +12883,31 @@ export interface SendResult {
|
|
|
11411
12883
|
*/
|
|
11412
12884
|
messageId: string;
|
|
11413
12885
|
}
|
|
12886
|
+
/**
|
|
12887
|
+
* Internal request for sending a system notification.
|
|
12888
|
+
*
|
|
12889
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12890
|
+
* via the `definition` "SendSystemNotificationRequest".
|
|
12891
|
+
*/
|
|
12892
|
+
/** @experimental */
|
|
12893
|
+
export interface SendSystemNotificationRequest {
|
|
12894
|
+
/**
|
|
12895
|
+
* Notification text to deliver to the model.
|
|
12896
|
+
*/
|
|
12897
|
+
message: string;
|
|
12898
|
+
/**
|
|
12899
|
+
* Optional structured notification kind.
|
|
12900
|
+
*/
|
|
12901
|
+
kind?: {
|
|
12902
|
+
[k: string]: unknown | undefined;
|
|
12903
|
+
};
|
|
12904
|
+
/**
|
|
12905
|
+
* Internal delivery options, including passive policy.
|
|
12906
|
+
*/
|
|
12907
|
+
options?: {
|
|
12908
|
+
[k: string]: unknown | undefined;
|
|
12909
|
+
};
|
|
12910
|
+
}
|
|
11414
12911
|
/**
|
|
11415
12912
|
* Agents discovered across user, project, plugin, and remote sources.
|
|
11416
12913
|
*
|
|
@@ -11873,7 +13370,7 @@ export interface SessionFsSqliteExistsResult {
|
|
|
11873
13370
|
exists: boolean;
|
|
11874
13371
|
}
|
|
11875
13372
|
/**
|
|
11876
|
-
* SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database.
|
|
13373
|
+
* 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.
|
|
11877
13374
|
*
|
|
11878
13375
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11879
13376
|
* via the `definition` "SessionFsSqliteQueryRequest".
|
|
@@ -11924,6 +13421,62 @@ export interface SessionFsSqliteQueryResult {
|
|
|
11924
13421
|
lastInsertRowid?: number;
|
|
11925
13422
|
error?: SessionFsError;
|
|
11926
13423
|
}
|
|
13424
|
+
/**
|
|
13425
|
+
* Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried.
|
|
13426
|
+
*
|
|
13427
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13428
|
+
* via the `definition` "SessionFsSqliteTransactionError".
|
|
13429
|
+
*/
|
|
13430
|
+
/** @experimental */
|
|
13431
|
+
export interface SessionFsSqliteTransactionError {
|
|
13432
|
+
errorClass: SessionFsSqliteTransactionErrorClass;
|
|
13433
|
+
message: string;
|
|
13434
|
+
}
|
|
13435
|
+
/**
|
|
13436
|
+
* Statements to execute atomically. Providers apply busy handling for every call.
|
|
13437
|
+
*
|
|
13438
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13439
|
+
* via the `definition` "SessionFsSqliteTransactionRequest".
|
|
13440
|
+
*/
|
|
13441
|
+
/** @experimental */
|
|
13442
|
+
export interface SessionFsSqliteTransactionRequest {
|
|
13443
|
+
/**
|
|
13444
|
+
* Target session identifier
|
|
13445
|
+
*/
|
|
13446
|
+
sessionId: string;
|
|
13447
|
+
statements: SessionFsSqliteTransactionStatement[];
|
|
13448
|
+
}
|
|
13449
|
+
/**
|
|
13450
|
+
* One statement in an atomic SQLite transaction.
|
|
13451
|
+
*
|
|
13452
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13453
|
+
* via the `definition` "SessionFsSqliteTransactionStatement".
|
|
13454
|
+
*/
|
|
13455
|
+
/** @experimental */
|
|
13456
|
+
export interface SessionFsSqliteTransactionStatement {
|
|
13457
|
+
/**
|
|
13458
|
+
* SQL statement to execute.
|
|
13459
|
+
*/
|
|
13460
|
+
query: string;
|
|
13461
|
+
queryType: SessionFsSqliteQueryType;
|
|
13462
|
+
/**
|
|
13463
|
+
* Optional named bind parameters.
|
|
13464
|
+
*/
|
|
13465
|
+
params?: {
|
|
13466
|
+
[k: string]: unknown | undefined;
|
|
13467
|
+
};
|
|
13468
|
+
}
|
|
13469
|
+
/**
|
|
13470
|
+
* Per-statement results, or a classified transaction error.
|
|
13471
|
+
*
|
|
13472
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13473
|
+
* via the `definition` "SessionFsSqliteTransactionResult".
|
|
13474
|
+
*/
|
|
13475
|
+
/** @experimental */
|
|
13476
|
+
export interface SessionFsSqliteTransactionResult {
|
|
13477
|
+
results: SessionFsSqliteQueryResult[];
|
|
13478
|
+
error?: SessionFsSqliteTransactionError;
|
|
13479
|
+
}
|
|
11927
13480
|
/**
|
|
11928
13481
|
* Path whose metadata should be returned from the client-provided session filesystem.
|
|
11929
13482
|
*
|
|
@@ -12031,7 +13584,7 @@ export interface SessionInstalledPlugin {
|
|
|
12031
13584
|
source?: SessionInstalledPluginSource;
|
|
12032
13585
|
}
|
|
12033
13586
|
/**
|
|
12034
|
-
* Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, and optional subpath.
|
|
13587
|
+
* Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref or full commit SHA, and optional subpath.
|
|
12035
13588
|
*
|
|
12036
13589
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12037
13590
|
* via the `definition` "SessionInstalledPluginSourceGitHub".
|
|
@@ -12044,10 +13597,14 @@ export interface SessionInstalledPluginSourceGitHub {
|
|
|
12044
13597
|
source: "github";
|
|
12045
13598
|
repo: string;
|
|
12046
13599
|
ref?: string;
|
|
13600
|
+
/**
|
|
13601
|
+
* Optional full 40-character hexadecimal commit SHA.
|
|
13602
|
+
*/
|
|
13603
|
+
sha?: string;
|
|
12047
13604
|
path?: string;
|
|
12048
13605
|
}
|
|
12049
13606
|
/**
|
|
12050
|
-
* Source descriptor for a direct URL plugin install, with URL, optional ref, and optional subpath.
|
|
13607
|
+
* Source descriptor for a direct URL plugin install, with URL, optional ref or full commit SHA, and optional subpath.
|
|
12051
13608
|
*
|
|
12052
13609
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12053
13610
|
* via the `definition` "SessionInstalledPluginSourceUrl".
|
|
@@ -12060,6 +13617,10 @@ export interface SessionInstalledPluginSourceUrl {
|
|
|
12060
13617
|
source: "url";
|
|
12061
13618
|
url: string;
|
|
12062
13619
|
ref?: string;
|
|
13620
|
+
/**
|
|
13621
|
+
* Optional full 40-character hexadecimal commit SHA.
|
|
13622
|
+
*/
|
|
13623
|
+
sha?: string;
|
|
12063
13624
|
path?: string;
|
|
12064
13625
|
}
|
|
12065
13626
|
/**
|
|
@@ -12076,6 +13637,70 @@ export interface SessionInstalledPluginSourceLocal {
|
|
|
12076
13637
|
source: "local";
|
|
12077
13638
|
path: string;
|
|
12078
13639
|
}
|
|
13640
|
+
/**
|
|
13641
|
+
* Baseline data provenance for a prediction.
|
|
13642
|
+
*
|
|
13643
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13644
|
+
* via the `definition` "SessionLimitPredictionBaselineData".
|
|
13645
|
+
*/
|
|
13646
|
+
/** @experimental */
|
|
13647
|
+
export interface SessionLimitPredictionBaselineData {
|
|
13648
|
+
/**
|
|
13649
|
+
* Start of the baseline data slice.
|
|
13650
|
+
*/
|
|
13651
|
+
windowStart: string;
|
|
13652
|
+
/**
|
|
13653
|
+
* End of the baseline data slice.
|
|
13654
|
+
*/
|
|
13655
|
+
windowEnd: string;
|
|
13656
|
+
}
|
|
13657
|
+
/**
|
|
13658
|
+
* Explainable AI-credit session-limit prediction.
|
|
13659
|
+
*
|
|
13660
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13661
|
+
* via the `definition` "SessionLimitPredictionDetails".
|
|
13662
|
+
*/
|
|
13663
|
+
/** @experimental */
|
|
13664
|
+
export interface SessionLimitPredictionDetails {
|
|
13665
|
+
clientType: SessionLimitPredictionClientType;
|
|
13666
|
+
/**
|
|
13667
|
+
* Model identifier used for lookup.
|
|
13668
|
+
*/
|
|
13669
|
+
modelId: string;
|
|
13670
|
+
source: SessionLimitPredictionSource;
|
|
13671
|
+
/**
|
|
13672
|
+
* Key matched at the source level, such as a model id, family id, or `global`.
|
|
13673
|
+
*/
|
|
13674
|
+
sourceKey: string;
|
|
13675
|
+
/**
|
|
13676
|
+
* Resolved model family when known.
|
|
13677
|
+
*/
|
|
13678
|
+
family?: string;
|
|
13679
|
+
/**
|
|
13680
|
+
* Ordered usage tiers and their AI-credit caps.
|
|
13681
|
+
*/
|
|
13682
|
+
tiers: SessionLimitPredictionTierOption[];
|
|
13683
|
+
baselineData: SessionLimitPredictionBaselineData;
|
|
13684
|
+
recommendedTier: SessionLimitPredictionTier;
|
|
13685
|
+
/**
|
|
13686
|
+
* Recommended maximum AI credits for this session.
|
|
13687
|
+
*/
|
|
13688
|
+
recommendedCap: number;
|
|
13689
|
+
}
|
|
13690
|
+
/**
|
|
13691
|
+
* Semantic usage tier and its AI-credit cap.
|
|
13692
|
+
*
|
|
13693
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13694
|
+
* via the `definition` "SessionLimitPredictionTierOption".
|
|
13695
|
+
*/
|
|
13696
|
+
/** @experimental */
|
|
13697
|
+
export interface SessionLimitPredictionTierOption {
|
|
13698
|
+
tier: SessionLimitPredictionTier;
|
|
13699
|
+
/**
|
|
13700
|
+
* AI-credit cap for this tier.
|
|
13701
|
+
*/
|
|
13702
|
+
cap: number;
|
|
13703
|
+
}
|
|
12079
13704
|
/**
|
|
12080
13705
|
* Sessions matching the filter, ordered most-recently-modified first.
|
|
12081
13706
|
*
|
|
@@ -12274,6 +13899,10 @@ export interface SessionOpenOptions {
|
|
|
12274
13899
|
* Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap.
|
|
12275
13900
|
*/
|
|
12276
13901
|
enableManagedSettings?: boolean;
|
|
13902
|
+
/**
|
|
13903
|
+
* 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.
|
|
13904
|
+
*/
|
|
13905
|
+
enableFileChangeTracking?: boolean;
|
|
12277
13906
|
/**
|
|
12278
13907
|
* Feature-flag values resolved by the host.
|
|
12279
13908
|
*/
|
|
@@ -12303,6 +13932,10 @@ export interface SessionOpenOptions {
|
|
|
12303
13932
|
* Working directory to anchor the session.
|
|
12304
13933
|
*/
|
|
12305
13934
|
workingDirectory?: string;
|
|
13935
|
+
/**
|
|
13936
|
+
* Additional directories the agent may access beyond the working directory. Each entry is granted to the session's file-access allow-list and surfaced to the model (system prompt context and `@`-mention completion). Absolute paths are recommended; a relative path is resolved against the session's working directory. Nonexistent or unresolvable entries are skipped with a warning. This is applied on both session creation and resume, and is not persisted: a resumed session that omits this option does not retain previously supplied directories (re-supply them, exactly as the CLI re-passes `--add-dir`).
|
|
13937
|
+
*/
|
|
13938
|
+
additionalDirectories?: string[];
|
|
12306
13939
|
workingDirectoryContext?: SessionContext;
|
|
12307
13940
|
/**
|
|
12308
13941
|
* Whether this session supports remote steering.
|
|
@@ -12344,12 +13977,14 @@ export interface SessionOpenOptions {
|
|
|
12344
13977
|
* Whether shell-script safety heuristics are enabled.
|
|
12345
13978
|
*/
|
|
12346
13979
|
enableScriptSafety?: boolean;
|
|
13980
|
+
shell?: ShellOptions;
|
|
12347
13981
|
/**
|
|
12348
|
-
*
|
|
13982
|
+
* @deprecated
|
|
13983
|
+
* Use shell.initProfile instead. Shell init profile.
|
|
12349
13984
|
*/
|
|
12350
13985
|
shellInitProfile?: string;
|
|
12351
13986
|
/**
|
|
12352
|
-
*
|
|
13987
|
+
* PowerShell process flags applied to built-in and user-requested shell commands.
|
|
12353
13988
|
*/
|
|
12354
13989
|
shellProcessFlags?: string[];
|
|
12355
13990
|
sandboxConfig?: SandboxConfig;
|
|
@@ -12438,6 +14073,10 @@ export interface SessionOpenOptions {
|
|
|
12438
14073
|
* Override directory for session event logs.
|
|
12439
14074
|
*/
|
|
12440
14075
|
eventsLogDirectory?: string;
|
|
14076
|
+
/**
|
|
14077
|
+
* Whether subagent callback events should be forwarded into the session event log sink.
|
|
14078
|
+
*/
|
|
14079
|
+
eventsLogIncludesSubagents?: boolean;
|
|
12441
14080
|
/**
|
|
12442
14081
|
* Override Copilot configuration directory.
|
|
12443
14082
|
*/
|
|
@@ -12454,6 +14093,48 @@ export interface SessionOpenOptions {
|
|
|
12454
14093
|
*/
|
|
12455
14094
|
sessionCapabilities?: SessionCapability[];
|
|
12456
14095
|
}
|
|
14096
|
+
/**
|
|
14097
|
+
* Per-session settings for built-in shell tools.
|
|
14098
|
+
*
|
|
14099
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14100
|
+
* via the `definition` "ShellOptions".
|
|
14101
|
+
*/
|
|
14102
|
+
/** @experimental */
|
|
14103
|
+
export interface ShellOptions {
|
|
14104
|
+
initProfile?: ShellInitProfile;
|
|
14105
|
+
/**
|
|
14106
|
+
* Ordered host-provided script paths sourced before each built-in shell command when the
|
|
14107
|
+
* entry's shell target matches the active shell. Use these for rc files, environment setup scripts,
|
|
14108
|
+
* or other custom scripts. A script that returns a nonzero status is reported, and later scripts
|
|
14109
|
+
* and the user command continue while the shell remains running. Because scripts are sourced into
|
|
14110
|
+
* the command shell, `exit`, `exec`, failures under `set -e`, or other shell-terminating behavior
|
|
14111
|
+
* can prevent continuation. Script standard output is preserved; Bash script stderr is discarded,
|
|
14112
|
+
* PowerShell exception messages are replaced, and runtime-generated failure notices omit
|
|
14113
|
+
* configured script paths. When sandboxing is enabled, each script must already be readable under
|
|
14114
|
+
* the active sandbox filesystem policy. Pass an empty array to clear the list.
|
|
14115
|
+
*/
|
|
14116
|
+
initScripts?: ShellInitScript[];
|
|
14117
|
+
/**
|
|
14118
|
+
* Flags passed to the active built-in shell process on startup, replacing its default flags.
|
|
14119
|
+
* When omitted, the built-in Bash shell uses `--norc --noprofile`,
|
|
14120
|
+
* and the built-in PowerShell shell uses `-NoProfile -NoLogo`.
|
|
14121
|
+
*/
|
|
14122
|
+
processFlags?: string[];
|
|
14123
|
+
}
|
|
14124
|
+
/**
|
|
14125
|
+
* A host-provided script sourced before each built-in shell command when its shell target matches the active shell.
|
|
14126
|
+
*
|
|
14127
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14128
|
+
* via the `definition` "ShellInitScript".
|
|
14129
|
+
*/
|
|
14130
|
+
/** @experimental */
|
|
14131
|
+
export interface ShellInitScript {
|
|
14132
|
+
/**
|
|
14133
|
+
* Path to the script to source.
|
|
14134
|
+
*/
|
|
14135
|
+
path: string;
|
|
14136
|
+
shell: ShellInitScriptShell;
|
|
14137
|
+
}
|
|
12457
14138
|
/**
|
|
12458
14139
|
* Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope.
|
|
12459
14140
|
*
|
|
@@ -12756,6 +14437,23 @@ export interface SessionsCloseRequest {
|
|
|
12756
14437
|
/** @experimental */
|
|
12757
14438
|
export interface SessionsCloseResult {
|
|
12758
14439
|
}
|
|
14440
|
+
/**
|
|
14441
|
+
* Session ID to delete from disk.
|
|
14442
|
+
*
|
|
14443
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14444
|
+
* via the `definition` "SessionsDeleteRequest".
|
|
14445
|
+
*/
|
|
14446
|
+
/** @experimental */
|
|
14447
|
+
export interface SessionsDeleteRequest {
|
|
14448
|
+
/**
|
|
14449
|
+
* Session ID to delete
|
|
14450
|
+
*/
|
|
14451
|
+
sessionId: string;
|
|
14452
|
+
/**
|
|
14453
|
+
* Internal resolved session directory path to delete
|
|
14454
|
+
*/
|
|
14455
|
+
sessionPath?: string | null;
|
|
14456
|
+
}
|
|
12759
14457
|
/**
|
|
12760
14458
|
* Session metadata records to enrich with summary and context information.
|
|
12761
14459
|
*
|
|
@@ -13089,6 +14787,29 @@ export interface SessionsGetLastForContextResult {
|
|
|
13089
14787
|
*/
|
|
13090
14788
|
sessionId?: string;
|
|
13091
14789
|
}
|
|
14790
|
+
/**
|
|
14791
|
+
* Session ID whose persisted metadata should be read.
|
|
14792
|
+
*
|
|
14793
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14794
|
+
* via the `definition` "SessionsGetMetadataRequest".
|
|
14795
|
+
*/
|
|
14796
|
+
/** @experimental */
|
|
14797
|
+
export interface SessionsGetMetadataRequest {
|
|
14798
|
+
/**
|
|
14799
|
+
* Session ID to inspect
|
|
14800
|
+
*/
|
|
14801
|
+
sessionId: string;
|
|
14802
|
+
}
|
|
14803
|
+
/**
|
|
14804
|
+
* Persisted local session metadata when the session exists.
|
|
14805
|
+
*
|
|
14806
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14807
|
+
* via the `definition` "SessionsGetMetadataResult".
|
|
14808
|
+
*/
|
|
14809
|
+
/** @experimental */
|
|
14810
|
+
export interface SessionsGetMetadataResult {
|
|
14811
|
+
session?: LocalSessionMetadataValue;
|
|
14812
|
+
}
|
|
13092
14813
|
/**
|
|
13093
14814
|
* Session ID to look up the persisted remote-steerable flag for.
|
|
13094
14815
|
*
|
|
@@ -13130,6 +14851,32 @@ export interface SessionSizes {
|
|
|
13130
14851
|
[k: string]: number | undefined;
|
|
13131
14852
|
};
|
|
13132
14853
|
}
|
|
14854
|
+
/**
|
|
14855
|
+
* Limit for non-empty local session IDs.
|
|
14856
|
+
*
|
|
14857
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14858
|
+
* via the `definition` "SessionsListNonEmptySessionIdsRequest".
|
|
14859
|
+
*/
|
|
14860
|
+
/** @experimental */
|
|
14861
|
+
export interface SessionsListNonEmptySessionIdsRequest {
|
|
14862
|
+
/**
|
|
14863
|
+
* Maximum number of session IDs to return.
|
|
14864
|
+
*/
|
|
14865
|
+
limit?: number;
|
|
14866
|
+
}
|
|
14867
|
+
/**
|
|
14868
|
+
* Recent local session IDs that contain user-visible history.
|
|
14869
|
+
*
|
|
14870
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14871
|
+
* via the `definition` "SessionsListNonEmptySessionIdsResult".
|
|
14872
|
+
*/
|
|
14873
|
+
/** @experimental */
|
|
14874
|
+
export interface SessionsListNonEmptySessionIdsResult {
|
|
14875
|
+
/**
|
|
14876
|
+
* Session IDs ordered newest-first.
|
|
14877
|
+
*/
|
|
14878
|
+
sessionIds: string[];
|
|
14879
|
+
}
|
|
13133
14880
|
/**
|
|
13134
14881
|
* Optional source filter, metadata-load limit, and context filter applied to the returned sessions.
|
|
13135
14882
|
*
|
|
@@ -13419,12 +15166,14 @@ export interface SessionUpdateOptionsParams {
|
|
|
13419
15166
|
* Whether shell-script safety heuristics are enabled.
|
|
13420
15167
|
*/
|
|
13421
15168
|
enableScriptSafety?: boolean;
|
|
15169
|
+
shell?: ShellOptions;
|
|
13422
15170
|
/**
|
|
13423
|
-
*
|
|
15171
|
+
* @deprecated
|
|
15172
|
+
* Use shell.initProfile instead. Shell init profile (`None` or `NonInteractive`).
|
|
13424
15173
|
*/
|
|
13425
15174
|
shellInitProfile?: string;
|
|
13426
15175
|
/**
|
|
13427
|
-
*
|
|
15176
|
+
* PowerShell process flags applied to built-in and user-requested shell commands.
|
|
13428
15177
|
*/
|
|
13429
15178
|
shellProcessFlags?: string[];
|
|
13430
15179
|
sandboxConfig?: SandboxConfig;
|
|
@@ -13446,7 +15195,7 @@ export interface SessionUpdateOptionsParams {
|
|
|
13446
15195
|
*/
|
|
13447
15196
|
disabledSkills?: string[];
|
|
13448
15197
|
/**
|
|
13449
|
-
* Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions
|
|
15198
|
+
* Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with `skipCustomInstructions`.
|
|
13450
15199
|
*/
|
|
13451
15200
|
enableOnDemandInstructionDiscovery?: boolean;
|
|
13452
15201
|
/**
|
|
@@ -13513,6 +15262,10 @@ export interface SessionUpdateOptionsParams {
|
|
|
13513
15262
|
* Override directory for the session-events log. When unset, the runtime's default events log directory is used.
|
|
13514
15263
|
*/
|
|
13515
15264
|
eventsLogDirectory?: string;
|
|
15265
|
+
/**
|
|
15266
|
+
* Whether subagent callback events should be forwarded into the session event log sink.
|
|
15267
|
+
*/
|
|
15268
|
+
eventsLogIncludesSubagents?: boolean;
|
|
13516
15269
|
/**
|
|
13517
15270
|
* Additional content-exclusion policies to merge into the session's policy set.
|
|
13518
15271
|
*
|
|
@@ -14974,6 +16727,10 @@ export interface UIExitPlanModeResponse {
|
|
|
14974
16727
|
* Feedback from the user when they declined the plan or requested changes.
|
|
14975
16728
|
*/
|
|
14976
16729
|
feedback?: string;
|
|
16730
|
+
/**
|
|
16731
|
+
* 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.
|
|
16732
|
+
*/
|
|
16733
|
+
deferImplementation?: boolean;
|
|
14977
16734
|
}
|
|
14978
16735
|
/**
|
|
14979
16736
|
* Request ID of a pending `auto_mode_switch.requested` event and the user's response.
|
|
@@ -15497,7 +17254,7 @@ export interface VisibilitySetResult {
|
|
|
15497
17254
|
/** @experimental */
|
|
15498
17255
|
export interface WorkspaceDiffFileChange {
|
|
15499
17256
|
/**
|
|
15500
|
-
* Path to the changed file, relative to the workspace root.
|
|
17257
|
+
* 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).
|
|
15501
17258
|
*/
|
|
15502
17259
|
path: string;
|
|
15503
17260
|
/**
|
|
@@ -15533,9 +17290,52 @@ export interface WorkspaceDiffResult {
|
|
|
15533
17290
|
*/
|
|
15534
17291
|
baseBranch?: string;
|
|
15535
17292
|
/**
|
|
15536
|
-
* Whether
|
|
17293
|
+
* Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable.
|
|
15537
17294
|
*/
|
|
15538
17295
|
isFallback: boolean;
|
|
17296
|
+
unavailableReason?: HistoryRewindUnavailableReason;
|
|
17297
|
+
}
|
|
17298
|
+
/**
|
|
17299
|
+
* Compaction summary checkpoint to persist.
|
|
17300
|
+
*
|
|
17301
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17302
|
+
* via the `definition` "WorkspacesAddSummaryRequest".
|
|
17303
|
+
*/
|
|
17304
|
+
/** @experimental */
|
|
17305
|
+
export interface WorkspacesAddSummaryRequest {
|
|
17306
|
+
/**
|
|
17307
|
+
* Summary title shown in checkpoint listings.
|
|
17308
|
+
*/
|
|
17309
|
+
title: string;
|
|
17310
|
+
/**
|
|
17311
|
+
* Markdown summary content to persist.
|
|
17312
|
+
*/
|
|
17313
|
+
content: string;
|
|
17314
|
+
}
|
|
17315
|
+
/**
|
|
17316
|
+
* Persisted summary metadata and refreshed workspace metadata.
|
|
17317
|
+
*
|
|
17318
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17319
|
+
* via the `definition` "WorkspacesAddSummaryResult".
|
|
17320
|
+
*/
|
|
17321
|
+
/** @experimental */
|
|
17322
|
+
export interface WorkspacesAddSummaryResult {
|
|
17323
|
+
summary?: {};
|
|
17324
|
+
workspace?: {};
|
|
17325
|
+
[k: string]: unknown | undefined;
|
|
17326
|
+
}
|
|
17327
|
+
/**
|
|
17328
|
+
* Whether the autopilot objective file exists.
|
|
17329
|
+
*
|
|
17330
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17331
|
+
* via the `definition` "WorkspacesAutopilotObjectiveExistsResult".
|
|
17332
|
+
*/
|
|
17333
|
+
/** @experimental */
|
|
17334
|
+
export interface WorkspacesAutopilotObjectiveExistsResult {
|
|
17335
|
+
/**
|
|
17336
|
+
* True when the objective file exists.
|
|
17337
|
+
*/
|
|
17338
|
+
exists: boolean;
|
|
15539
17339
|
}
|
|
15540
17340
|
/**
|
|
15541
17341
|
* Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename.
|
|
@@ -15565,15 +17365,28 @@ export interface WorkspacesCheckpoints {
|
|
|
15565
17365
|
* via the `definition` "WorkspacesCreateFileRequest".
|
|
15566
17366
|
*/
|
|
15567
17367
|
/** @experimental */
|
|
15568
|
-
export interface WorkspacesCreateFileRequest {
|
|
15569
|
-
/**
|
|
15570
|
-
* Relative path within the workspace files directory
|
|
15571
|
-
*/
|
|
15572
|
-
path: string;
|
|
17368
|
+
export interface WorkspacesCreateFileRequest {
|
|
17369
|
+
/**
|
|
17370
|
+
* Relative path within the workspace files directory
|
|
17371
|
+
*/
|
|
17372
|
+
path: string;
|
|
17373
|
+
/**
|
|
17374
|
+
* File content to write as a UTF-8 string
|
|
17375
|
+
*/
|
|
17376
|
+
content: string;
|
|
17377
|
+
}
|
|
17378
|
+
/**
|
|
17379
|
+
* Result of deleting the autopilot objective file.
|
|
17380
|
+
*
|
|
17381
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17382
|
+
* via the `definition` "WorkspacesDeleteAutopilotObjectiveResult".
|
|
17383
|
+
*/
|
|
17384
|
+
/** @experimental */
|
|
17385
|
+
export interface WorkspacesDeleteAutopilotObjectiveResult {
|
|
15573
17386
|
/**
|
|
15574
|
-
*
|
|
17387
|
+
* True when a file was deleted.
|
|
15575
17388
|
*/
|
|
15576
|
-
|
|
17389
|
+
deleted: boolean;
|
|
15577
17390
|
}
|
|
15578
17391
|
/**
|
|
15579
17392
|
* Parameters for computing a workspace diff.
|
|
@@ -15589,6 +17402,21 @@ export interface WorkspacesDiffRequest {
|
|
|
15589
17402
|
*/
|
|
15590
17403
|
ignoreWhitespace?: boolean;
|
|
15591
17404
|
}
|
|
17405
|
+
/**
|
|
17406
|
+
* Optional session context used when creating a local workspace.
|
|
17407
|
+
*
|
|
17408
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17409
|
+
* via the `definition` "WorkspacesEnsureRequest".
|
|
17410
|
+
*/
|
|
17411
|
+
/** @experimental */
|
|
17412
|
+
export interface WorkspacesEnsureRequest {
|
|
17413
|
+
/**
|
|
17414
|
+
* Opaque workspace context supplied by the session host.
|
|
17415
|
+
*/
|
|
17416
|
+
context?: {
|
|
17417
|
+
[k: string]: unknown | undefined;
|
|
17418
|
+
};
|
|
17419
|
+
}
|
|
15592
17420
|
/**
|
|
15593
17421
|
* Current workspace metadata for the session, including its absolute filesystem path when available.
|
|
15594
17422
|
*
|
|
@@ -15650,6 +17478,19 @@ export interface WorkspacesListFilesResult {
|
|
|
15650
17478
|
*/
|
|
15651
17479
|
files: string[];
|
|
15652
17480
|
}
|
|
17481
|
+
/**
|
|
17482
|
+
* Autopilot objective file content, or null when missing.
|
|
17483
|
+
*
|
|
17484
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17485
|
+
* via the `definition` "WorkspacesReadAutopilotObjectiveResult".
|
|
17486
|
+
*/
|
|
17487
|
+
/** @experimental */
|
|
17488
|
+
export interface WorkspacesReadAutopilotObjectiveResult {
|
|
17489
|
+
/**
|
|
17490
|
+
* Autopilot objective file content, or null when missing.
|
|
17491
|
+
*/
|
|
17492
|
+
content: string | null;
|
|
17493
|
+
}
|
|
15653
17494
|
/**
|
|
15654
17495
|
* Checkpoint number to read.
|
|
15655
17496
|
*
|
|
@@ -15741,6 +17582,82 @@ export interface WorkspacesSaveLargePasteResult {
|
|
|
15741
17582
|
sizeBytes: number;
|
|
15742
17583
|
} | null;
|
|
15743
17584
|
}
|
|
17585
|
+
/**
|
|
17586
|
+
* Rollback point for local workspace summaries.
|
|
17587
|
+
*
|
|
17588
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17589
|
+
* via the `definition` "WorkspacesTruncateSummariesRequest".
|
|
17590
|
+
*/
|
|
17591
|
+
/** @experimental */
|
|
17592
|
+
export interface WorkspacesTruncateSummariesRequest {
|
|
17593
|
+
/**
|
|
17594
|
+
* Number of newest summaries to keep.
|
|
17595
|
+
*/
|
|
17596
|
+
keepCount: number;
|
|
17597
|
+
}
|
|
17598
|
+
/**
|
|
17599
|
+
* Workspace metadata fields to update.
|
|
17600
|
+
*
|
|
17601
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17602
|
+
* via the `definition` "WorkspacesUpdateMetadataRequest".
|
|
17603
|
+
*/
|
|
17604
|
+
/** @experimental */
|
|
17605
|
+
export interface WorkspacesUpdateMetadataRequest {
|
|
17606
|
+
/**
|
|
17607
|
+
* Opaque workspace context supplied by the session host.
|
|
17608
|
+
*/
|
|
17609
|
+
context?: {
|
|
17610
|
+
[k: string]: unknown | undefined;
|
|
17611
|
+
};
|
|
17612
|
+
/**
|
|
17613
|
+
* Optional workspace display name override.
|
|
17614
|
+
*/
|
|
17615
|
+
name?: string;
|
|
17616
|
+
}
|
|
17617
|
+
/**
|
|
17618
|
+
* Autopilot objective file content to persist.
|
|
17619
|
+
*
|
|
17620
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17621
|
+
* via the `definition` "WorkspacesWriteAutopilotObjectiveRequest".
|
|
17622
|
+
*/
|
|
17623
|
+
/** @experimental */
|
|
17624
|
+
export interface WorkspacesWriteAutopilotObjectiveRequest {
|
|
17625
|
+
/**
|
|
17626
|
+
* Autopilot objective file content.
|
|
17627
|
+
*/
|
|
17628
|
+
content: string;
|
|
17629
|
+
}
|
|
17630
|
+
/**
|
|
17631
|
+
* Result of writing the autopilot objective file.
|
|
17632
|
+
*
|
|
17633
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17634
|
+
* via the `definition` "WorkspacesWriteAutopilotObjectiveResult".
|
|
17635
|
+
*/
|
|
17636
|
+
/** @experimental */
|
|
17637
|
+
export interface WorkspacesWriteAutopilotObjectiveResult {
|
|
17638
|
+
/**
|
|
17639
|
+
* Filesystem operation performed.
|
|
17640
|
+
*/
|
|
17641
|
+
operation: string;
|
|
17642
|
+
}
|
|
17643
|
+
/** @experimental */
|
|
17644
|
+
export interface SessionModelListRequest {
|
|
17645
|
+
/**
|
|
17646
|
+
* If true, bypasses the per-session model list cache and re-fetches from CAPI.
|
|
17647
|
+
*/
|
|
17648
|
+
skipCache?: boolean;
|
|
17649
|
+
}
|
|
17650
|
+
/** @experimental */
|
|
17651
|
+
export interface SessionAgentListRequest {
|
|
17652
|
+
/**
|
|
17653
|
+
* 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.
|
|
17654
|
+
*/
|
|
17655
|
+
includeBuiltInAgents?: boolean;
|
|
17656
|
+
/**
|
|
17657
|
+
* 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.
|
|
17658
|
+
*/
|
|
17659
|
+
includePrompt?: boolean;
|
|
17660
|
+
}
|
|
15744
17661
|
/**
|
|
15745
17662
|
* Standard MCP CallToolResult
|
|
15746
17663
|
*
|
|
@@ -15751,6 +17668,76 @@ export interface WorkspacesSaveLargePasteResult {
|
|
|
15751
17668
|
export interface SessionMcpAppsCallToolResult {
|
|
15752
17669
|
[k: string]: unknown | undefined;
|
|
15753
17670
|
}
|
|
17671
|
+
/** @experimental */
|
|
17672
|
+
export interface SessionPluginsReloadRequest {
|
|
17673
|
+
/**
|
|
17674
|
+
* Reload MCP server connections after refreshing plugins. Defaults to true.
|
|
17675
|
+
*/
|
|
17676
|
+
reloadMcp?: boolean;
|
|
17677
|
+
/**
|
|
17678
|
+
* Re-run custom-agent discovery after refreshing plugins. Defaults to true.
|
|
17679
|
+
*/
|
|
17680
|
+
reloadCustomAgents?: boolean;
|
|
17681
|
+
/**
|
|
17682
|
+
* 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).
|
|
17683
|
+
*/
|
|
17684
|
+
reloadHooks?: boolean;
|
|
17685
|
+
/**
|
|
17686
|
+
* 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).
|
|
17687
|
+
*/
|
|
17688
|
+
reloadExtensions?: boolean;
|
|
17689
|
+
/**
|
|
17690
|
+
* When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`.
|
|
17691
|
+
*/
|
|
17692
|
+
deferRepoHooks?: boolean;
|
|
17693
|
+
}
|
|
17694
|
+
/** @experimental */
|
|
17695
|
+
export interface SessionProviderGetEndpointRequest {
|
|
17696
|
+
/**
|
|
17697
|
+
* 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.
|
|
17698
|
+
*/
|
|
17699
|
+
modelId?: string;
|
|
17700
|
+
}
|
|
17701
|
+
/** @experimental */
|
|
17702
|
+
export interface SessionCommandsListRequest {
|
|
17703
|
+
/**
|
|
17704
|
+
* Include runtime built-in commands
|
|
17705
|
+
*/
|
|
17706
|
+
includeBuiltins?: boolean;
|
|
17707
|
+
/**
|
|
17708
|
+
* Include enabled user-invocable skills and commands
|
|
17709
|
+
*/
|
|
17710
|
+
includeSkills?: boolean;
|
|
17711
|
+
/**
|
|
17712
|
+
* Include commands registered by protocol clients, including SDK clients and extensions
|
|
17713
|
+
*/
|
|
17714
|
+
includeClientCommands?: boolean;
|
|
17715
|
+
}
|
|
17716
|
+
/** @experimental */
|
|
17717
|
+
export interface SessionHistoryCompactRequest {
|
|
17718
|
+
/**
|
|
17719
|
+
* Optional user-provided instructions to focus the compaction summary
|
|
17720
|
+
*/
|
|
17721
|
+
customInstructions?: string;
|
|
17722
|
+
/**
|
|
17723
|
+
* 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).
|
|
17724
|
+
*/
|
|
17725
|
+
trigger?: "manual"
|
|
17726
|
+
/** Compaction requested while switching to a model with a smaller context window. */
|
|
17727
|
+
| "model_switch";
|
|
17728
|
+
/**
|
|
17729
|
+
* 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.
|
|
17730
|
+
*/
|
|
17731
|
+
tokenLimit?: number;
|
|
17732
|
+
}
|
|
17733
|
+
/** @experimental */
|
|
17734
|
+
export interface SessionLimitPredictionPredictRequest {
|
|
17735
|
+
/**
|
|
17736
|
+
* Optional model identifier override. If omitted, the session's current model is used.
|
|
17737
|
+
*/
|
|
17738
|
+
modelId?: string;
|
|
17739
|
+
clientType?: SessionLimitPredictionClientType;
|
|
17740
|
+
}
|
|
15754
17741
|
/**
|
|
15755
17742
|
* Identifies the target session.
|
|
15756
17743
|
*
|
|
@@ -15786,6 +17773,12 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
15786
17773
|
* @returns List of Copilot models available to the resolved user, including capabilities and billing metadata.
|
|
15787
17774
|
*/
|
|
15788
17775
|
list: (params: ModelsListRequest) => Promise<ModelList>;
|
|
17776
|
+
/**
|
|
17777
|
+
* Returns the running runtime's complete catalog of well-known built-in model IDs without authentication or network access.
|
|
17778
|
+
*
|
|
17779
|
+
* @returns The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata.
|
|
17780
|
+
*/
|
|
17781
|
+
getBuiltInCatalog: () => Promise<BuiltInModelCatalog>;
|
|
15789
17782
|
};
|
|
15790
17783
|
/** @experimental */
|
|
15791
17784
|
tools: {
|
|
@@ -16367,6 +18360,24 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16367
18360
|
* @experimental
|
|
16368
18361
|
*/
|
|
16369
18362
|
abort: (params: AbortRequest) => Promise<AbortResult>;
|
|
18363
|
+
/**
|
|
18364
|
+
* 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.
|
|
18365
|
+
*
|
|
18366
|
+
* @param params Parameters for interrupting the main agent turn.
|
|
18367
|
+
*
|
|
18368
|
+
* @returns Result of interrupting the main agent turn.
|
|
18369
|
+
*
|
|
18370
|
+
* @experimental
|
|
18371
|
+
*/
|
|
18372
|
+
interruptMainTurn: (params: InterruptMainTurnRequest) => Promise<InterruptMainTurnResult>;
|
|
18373
|
+
/**
|
|
18374
|
+
* Cancels every running background agent (task-registry subagents plus sidekick agents) without interrupting the main agent loop. Promoted attached shells are left running.
|
|
18375
|
+
*
|
|
18376
|
+
* @returns The number of running background agents (task-registry agents) that were cancelled.
|
|
18377
|
+
*
|
|
18378
|
+
* @experimental
|
|
18379
|
+
*/
|
|
18380
|
+
cancelAllBackgroundAgents: () => Promise<SessionCancelAllBackgroundAgentsResult>;
|
|
16370
18381
|
/**
|
|
16371
18382
|
* 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.
|
|
16372
18383
|
*
|
|
@@ -16453,6 +18464,14 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16453
18464
|
* @returns Complete current or terminal factory run envelope.
|
|
16454
18465
|
*/
|
|
16455
18466
|
run: (params: FactoryRunRequest) => Promise<FactoryRunResult>;
|
|
18467
|
+
/**
|
|
18468
|
+
* Resumes a factory run using its persisted name, arguments, journal, and accounting.
|
|
18469
|
+
*
|
|
18470
|
+
* @param params Parameters for resuming a factory run from its persisted identity.
|
|
18471
|
+
*
|
|
18472
|
+
* @returns Resolved persisted factory identity and resumed run envelope.
|
|
18473
|
+
*/
|
|
18474
|
+
resume: (params: FactoryResumeRequest) => Promise<FactoryResumeResult>;
|
|
16456
18475
|
/**
|
|
16457
18476
|
* Gets the current or settled envelope for a factory run.
|
|
16458
18477
|
*
|
|
@@ -16461,6 +18480,28 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16461
18480
|
* @returns Complete current or terminal factory run envelope.
|
|
16462
18481
|
*/
|
|
16463
18482
|
getRun: (params: FactoryGetRunRequest) => Promise<FactoryRunResult>;
|
|
18483
|
+
/**
|
|
18484
|
+
* Lists durable factory runs for this session in creation order.
|
|
18485
|
+
*
|
|
18486
|
+
* @returns Factory runs in durable creation order.
|
|
18487
|
+
*/
|
|
18488
|
+
listRuns: () => Promise<FactoryListRunsResult>;
|
|
18489
|
+
/**
|
|
18490
|
+
* Gets durable and live observability detail for one factory run.
|
|
18491
|
+
*
|
|
18492
|
+
* @param params Parameters for retrieving a factory run.
|
|
18493
|
+
*
|
|
18494
|
+
* @returns Full factory run observability detail.
|
|
18495
|
+
*/
|
|
18496
|
+
getRunDetail: (params: FactoryGetRunRequest) => Promise<FactoryRunDetail>;
|
|
18497
|
+
/**
|
|
18498
|
+
* Pages durable progress for one factory run.
|
|
18499
|
+
*
|
|
18500
|
+
* @param params Parameters for paging factory progress.
|
|
18501
|
+
*
|
|
18502
|
+
* @returns A bidirectional page of factory progress.
|
|
18503
|
+
*/
|
|
18504
|
+
getRunProgress: (params: FactoryGetRunProgressRequest) => Promise<FactoryProgressPage>;
|
|
16464
18505
|
/**
|
|
16465
18506
|
* Requests cancellation of a factory run and returns its run envelope.
|
|
16466
18507
|
*
|
|
@@ -16536,7 +18577,7 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16536
18577
|
*
|
|
16537
18578
|
* @returns The list of models available to this session.
|
|
16538
18579
|
*/
|
|
16539
|
-
list: (params?:
|
|
18580
|
+
list: (params?: SessionModelListRequest) => Promise<SessionModelList>;
|
|
16540
18581
|
};
|
|
16541
18582
|
/** @experimental */
|
|
16542
18583
|
mode: {
|
|
@@ -16615,6 +18656,22 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16615
18656
|
* @returns Current workspace metadata for the session, including its absolute filesystem path when available.
|
|
16616
18657
|
*/
|
|
16617
18658
|
getWorkspace: () => Promise<WorkspacesGetWorkspaceResult>;
|
|
18659
|
+
/**
|
|
18660
|
+
* Updates workspace metadata for a local session and returns the refreshed workspace.
|
|
18661
|
+
*
|
|
18662
|
+
* @param params Workspace metadata fields to update.
|
|
18663
|
+
*
|
|
18664
|
+
* @returns Current workspace metadata for the session, including its absolute filesystem path when available.
|
|
18665
|
+
*/
|
|
18666
|
+
updateMetadata: (params: WorkspacesUpdateMetadataRequest) => Promise<WorkspacesGetWorkspaceResult>;
|
|
18667
|
+
/**
|
|
18668
|
+
* Ensures a local session workspace exists and returns it.
|
|
18669
|
+
*
|
|
18670
|
+
* @param params Optional session context used when creating a local workspace.
|
|
18671
|
+
*
|
|
18672
|
+
* @returns Current workspace metadata for the session, including its absolute filesystem path when available.
|
|
18673
|
+
*/
|
|
18674
|
+
ensure: (params: WorkspacesEnsureRequest) => Promise<WorkspacesGetWorkspaceResult>;
|
|
16618
18675
|
/**
|
|
16619
18676
|
* Lists files stored in the session workspace files directory.
|
|
16620
18677
|
*
|
|
@@ -16649,6 +18706,48 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16649
18706
|
* @returns Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing.
|
|
16650
18707
|
*/
|
|
16651
18708
|
readCheckpoint: (params: WorkspacesReadCheckpointRequest) => Promise<WorkspacesReadCheckpointResult>;
|
|
18709
|
+
/**
|
|
18710
|
+
* Adds a compaction summary checkpoint to the local session workspace.
|
|
18711
|
+
*
|
|
18712
|
+
* @param params Compaction summary checkpoint to persist.
|
|
18713
|
+
*
|
|
18714
|
+
* @returns Persisted summary metadata and refreshed workspace metadata.
|
|
18715
|
+
*/
|
|
18716
|
+
addSummary: (params: WorkspacesAddSummaryRequest) => Promise<WorkspacesAddSummaryResult>;
|
|
18717
|
+
/**
|
|
18718
|
+
* Truncates local workspace compaction summaries after a rollback.
|
|
18719
|
+
*
|
|
18720
|
+
* @param params Rollback point for local workspace summaries.
|
|
18721
|
+
*
|
|
18722
|
+
* @returns Current workspace metadata for the session, including its absolute filesystem path when available.
|
|
18723
|
+
*/
|
|
18724
|
+
truncateSummaries: (params: WorkspacesTruncateSummariesRequest) => Promise<WorkspacesGetWorkspaceResult>;
|
|
18725
|
+
/**
|
|
18726
|
+
* Reads the autopilot objective state file from the local session workspace.
|
|
18727
|
+
*
|
|
18728
|
+
* @returns Autopilot objective file content, or null when missing.
|
|
18729
|
+
*/
|
|
18730
|
+
readAutopilotObjective: () => Promise<WorkspacesReadAutopilotObjectiveResult>;
|
|
18731
|
+
/**
|
|
18732
|
+
* Writes the autopilot objective state file in the local session workspace.
|
|
18733
|
+
*
|
|
18734
|
+
* @param params Autopilot objective file content to persist.
|
|
18735
|
+
*
|
|
18736
|
+
* @returns Result of writing the autopilot objective file.
|
|
18737
|
+
*/
|
|
18738
|
+
writeAutopilotObjective: (params: WorkspacesWriteAutopilotObjectiveRequest) => Promise<WorkspacesWriteAutopilotObjectiveResult>;
|
|
18739
|
+
/**
|
|
18740
|
+
* Deletes the autopilot objective state file from the local session workspace.
|
|
18741
|
+
*
|
|
18742
|
+
* @returns Result of deleting the autopilot objective file.
|
|
18743
|
+
*/
|
|
18744
|
+
deleteAutopilotObjective: () => Promise<WorkspacesDeleteAutopilotObjectiveResult>;
|
|
18745
|
+
/**
|
|
18746
|
+
* Checks whether the local session workspace has an autopilot objective state file.
|
|
18747
|
+
*
|
|
18748
|
+
* @returns Whether the autopilot objective file exists.
|
|
18749
|
+
*/
|
|
18750
|
+
autopilotObjectiveExists: () => Promise<WorkspacesAutopilotObjectiveExistsResult>;
|
|
16652
18751
|
/**
|
|
16653
18752
|
* Saves pasted content as a UTF-8 file in the session workspace.
|
|
16654
18753
|
*
|
|
@@ -16658,7 +18757,7 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16658
18757
|
*/
|
|
16659
18758
|
saveLargePaste: (params: WorkspacesSaveLargePasteRequest) => Promise<WorkspacesSaveLargePasteResult>;
|
|
16660
18759
|
/**
|
|
16661
|
-
* Computes a diff for the session workspace.
|
|
18760
|
+
* 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`.
|
|
16662
18761
|
*
|
|
16663
18762
|
* @param params Parameters for computing a workspace diff.
|
|
16664
18763
|
*
|
|
@@ -16706,11 +18805,13 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16706
18805
|
/** @experimental */
|
|
16707
18806
|
agent: {
|
|
16708
18807
|
/**
|
|
16709
|
-
* Lists
|
|
18808
|
+
* Lists agents available to the session. Defaults to custom agents only; pass includeBuiltInAgents to include the effective built-in agents.
|
|
18809
|
+
*
|
|
18810
|
+
* @param params Controls whether built-in agents and authored prompt text are included.
|
|
16710
18811
|
*
|
|
16711
|
-
* @returns
|
|
18812
|
+
* @returns Agents available to the session.
|
|
16712
18813
|
*/
|
|
16713
|
-
list: () => Promise<AgentList>;
|
|
18814
|
+
list: (params?: SessionAgentListRequest) => Promise<AgentList>;
|
|
16714
18815
|
/**
|
|
16715
18816
|
* Gets the currently selected custom agent for the session.
|
|
16716
18817
|
*
|
|
@@ -16917,9 +19018,9 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16917
19018
|
*/
|
|
16918
19019
|
removeGitHub: () => Promise<McpRemoveGitHubResult>;
|
|
16919
19020
|
/**
|
|
16920
|
-
* Starts an individual MCP server on the live session from a caller-supplied
|
|
19021
|
+
* 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.
|
|
16921
19022
|
*
|
|
16922
|
-
* @param params Server name and configuration for an individual MCP server start.
|
|
19023
|
+
* @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.
|
|
16923
19024
|
*/
|
|
16924
19025
|
startServer: (params: McpStartServerRequest) => Promise<void>;
|
|
16925
19026
|
/**
|
|
@@ -16960,6 +19061,14 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
16960
19061
|
* @returns OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server.
|
|
16961
19062
|
*/
|
|
16962
19063
|
login: (params: McpOauthLoginRequest) => Promise<McpOauthLoginResult>;
|
|
19064
|
+
/**
|
|
19065
|
+
* Responds to a pending MCP OAuth authorization request by its request id.
|
|
19066
|
+
*
|
|
19067
|
+
* @param params Pending MCP OAuth request id to respond to.
|
|
19068
|
+
*
|
|
19069
|
+
* @returns Indicates whether the pending MCP OAuth response was accepted.
|
|
19070
|
+
*/
|
|
19071
|
+
respond: (params: McpOauthRespondRequest) => Promise<McpOauthRespondResult>;
|
|
16963
19072
|
};
|
|
16964
19073
|
/** @experimental */
|
|
16965
19074
|
headers: {
|
|
@@ -17060,7 +19169,7 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17060
19169
|
*
|
|
17061
19170
|
* @param params Optional flags controlling which side effects the reload performs.
|
|
17062
19171
|
*/
|
|
17063
|
-
reload: (params?:
|
|
19172
|
+
reload: (params?: SessionPluginsReloadRequest) => Promise<void>;
|
|
17064
19173
|
};
|
|
17065
19174
|
/** @experimental */
|
|
17066
19175
|
provider: {
|
|
@@ -17071,7 +19180,7 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17071
19180
|
*
|
|
17072
19181
|
* @returns A snapshot of the provider endpoint the session is currently configured to talk to.
|
|
17073
19182
|
*/
|
|
17074
|
-
getEndpoint: (params?:
|
|
19183
|
+
getEndpoint: (params?: SessionProviderGetEndpointRequest) => Promise<ProviderEndpoint>;
|
|
17075
19184
|
/**
|
|
17076
19185
|
* 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.
|
|
17077
19186
|
*
|
|
@@ -17172,7 +19281,7 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17172
19281
|
*
|
|
17173
19282
|
* @returns Slash commands available in the session, after applying any include/exclude filters.
|
|
17174
19283
|
*/
|
|
17175
|
-
list: (params?:
|
|
19284
|
+
list: (params?: SessionCommandsListRequest) => Promise<CommandList>;
|
|
17176
19285
|
/**
|
|
17177
19286
|
* Invokes a slash command in the session.
|
|
17178
19287
|
*
|
|
@@ -17375,9 +19484,11 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17375
19484
|
/**
|
|
17376
19485
|
* Clears session-scoped tool permission approvals.
|
|
17377
19486
|
*
|
|
19487
|
+
* @param params Clears session-scoped tool permission approvals, and optionally the location-scoped ones.
|
|
19488
|
+
*
|
|
17378
19489
|
* @returns Indicates whether the operation succeeded.
|
|
17379
19490
|
*/
|
|
17380
|
-
resetSessionApprovals: () => Promise<PermissionsResetSessionApprovalsResult>;
|
|
19491
|
+
resetSessionApprovals: (params: PermissionsResetSessionApprovalsRequest) => Promise<PermissionsResetSessionApprovalsResult>;
|
|
17381
19492
|
/**
|
|
17382
19493
|
* Notifies the runtime that a permission prompt UI has been shown to the user.
|
|
17383
19494
|
*
|
|
@@ -17563,9 +19674,20 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17563
19674
|
recomputeContextTokens: (params: MetadataRecomputeContextTokensRequest) => Promise<MetadataRecomputeContextTokensResult>;
|
|
17564
19675
|
};
|
|
17565
19676
|
/** @experimental */
|
|
19677
|
+
contentExclusion: {
|
|
19678
|
+
/**
|
|
19679
|
+
* 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.
|
|
19680
|
+
*
|
|
19681
|
+
* @param params Local file system absolute paths within the session working directory to check against its content-exclusion policy.
|
|
19682
|
+
*
|
|
19683
|
+
* @returns Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable.
|
|
19684
|
+
*/
|
|
19685
|
+
checkPaths: (params: ContentExclusionCheckPathsRequest) => Promise<ContentExclusionCheckPathsResult>;
|
|
19686
|
+
};
|
|
19687
|
+
/** @experimental */
|
|
17566
19688
|
shell: {
|
|
17567
19689
|
/**
|
|
17568
|
-
* Starts a shell command and streams output through session notifications.
|
|
19690
|
+
* 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.
|
|
17569
19691
|
*
|
|
17570
19692
|
* @param params Shell command to run, with optional working directory and timeout in milliseconds.
|
|
17571
19693
|
*
|
|
@@ -17573,7 +19695,7 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17573
19695
|
*/
|
|
17574
19696
|
exec: (params: ShellExecRequest) => Promise<ShellExecResult>;
|
|
17575
19697
|
/**
|
|
17576
|
-
* Sends a signal to a shell process previously started via "shell.exec".
|
|
19698
|
+
* 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.
|
|
17577
19699
|
*
|
|
17578
19700
|
* @param params Identifier of a process previously returned by "shell.exec" and the signal to send.
|
|
17579
19701
|
*
|
|
@@ -17606,7 +19728,7 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17606
19728
|
*
|
|
17607
19729
|
* @returns Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown.
|
|
17608
19730
|
*/
|
|
17609
|
-
compact: (params?:
|
|
19731
|
+
compact: (params?: SessionHistoryCompactRequest) => Promise<HistoryCompactResult>;
|
|
17610
19732
|
/**
|
|
17611
19733
|
* Truncates persisted session history to a specific event.
|
|
17612
19734
|
*
|
|
@@ -17615,6 +19737,28 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17615
19737
|
* @returns Number of events that were removed by the truncation.
|
|
17616
19738
|
*/
|
|
17617
19739
|
truncate: (params: HistoryTruncateRequest) => Promise<HistoryTruncateResult>;
|
|
19740
|
+
/**
|
|
19741
|
+
* 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.
|
|
19742
|
+
*
|
|
19743
|
+
* @returns Rewind points and file-change-tracking availability for the session.
|
|
19744
|
+
*/
|
|
19745
|
+
listRewindPoints: () => Promise<HistoryListRewindPointsResult>;
|
|
19746
|
+
/**
|
|
19747
|
+
* Previews the files that a conversation-and-files rewind would restore.
|
|
19748
|
+
*
|
|
19749
|
+
* @param params Event boundary to preview for conversation-and-files rewind.
|
|
19750
|
+
*
|
|
19751
|
+
* @returns Files and aggregate changes for a prospective rewind.
|
|
19752
|
+
*/
|
|
19753
|
+
previewRewind: (params: HistoryPreviewRewindRequest) => Promise<HistoryPreviewRewindResult>;
|
|
19754
|
+
/**
|
|
19755
|
+
* 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.
|
|
19756
|
+
*
|
|
19757
|
+
* @param params Boundary and mode for rewinding session history.
|
|
19758
|
+
*
|
|
19759
|
+
* @returns Structured outcome of a rewind request.
|
|
19760
|
+
*/
|
|
19761
|
+
rewind: (params: HistoryRewindRequest) => Promise<HistoryRewindResult>;
|
|
17618
19762
|
/**
|
|
17619
19763
|
* Cancels any in-progress background compaction on a local session.
|
|
17620
19764
|
*
|
|
@@ -17642,6 +19786,60 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17642
19786
|
* @returns Snapshot of the session's pending queued items and immediate-steering messages.
|
|
17643
19787
|
*/
|
|
17644
19788
|
pendingItems: () => Promise<QueuePendingItemsResult>;
|
|
19789
|
+
/**
|
|
19790
|
+
* Moves an addressable queued item to a public visible position.
|
|
19791
|
+
*
|
|
19792
|
+
* @param params Parameters for moving a queued item by stable id.
|
|
19793
|
+
*
|
|
19794
|
+
* @returns Result of moving a queued item.
|
|
19795
|
+
*/
|
|
19796
|
+
moveItem: (params: QueueMoveItemRequest) => Promise<QueueMoveItemResult>;
|
|
19797
|
+
/**
|
|
19798
|
+
* Inserts a new queued message at a public visible position.
|
|
19799
|
+
*
|
|
19800
|
+
* @param params Parameters for inserting a queued message at a public visible position.
|
|
19801
|
+
*
|
|
19802
|
+
* @returns Result of inserting a queued message.
|
|
19803
|
+
*/
|
|
19804
|
+
insertAt: (params: QueueInsertAtRequest) => Promise<QueueInsertAtResult>;
|
|
19805
|
+
/**
|
|
19806
|
+
* Removes an addressable queued item by its stable id.
|
|
19807
|
+
*
|
|
19808
|
+
* @param params Parameters for removing a queued item by stable id.
|
|
19809
|
+
*
|
|
19810
|
+
* @returns Result of removing a queued item.
|
|
19811
|
+
*/
|
|
19812
|
+
removeAt: (params: QueueRemoveAtRequest) => Promise<QueueRemoveAtResult>;
|
|
19813
|
+
/**
|
|
19814
|
+
* Updates the text of an addressable single-message queue item.
|
|
19815
|
+
*
|
|
19816
|
+
* @param params Parameters for editing a single queued message.
|
|
19817
|
+
*
|
|
19818
|
+
* @returns Result of editing a queued message.
|
|
19819
|
+
*/
|
|
19820
|
+
updateText: (params: QueueUpdateTextRequest) => Promise<QueueUpdateTextResult>;
|
|
19821
|
+
/**
|
|
19822
|
+
* Duplicates an addressable queued item immediately after its source.
|
|
19823
|
+
*
|
|
19824
|
+
* @param params Parameters for duplicating a queued item.
|
|
19825
|
+
*
|
|
19826
|
+
* @returns Result of duplicating a queued item.
|
|
19827
|
+
*/
|
|
19828
|
+
duplicateAt: (params: QueueDuplicateAtRequest) => Promise<QueueDuplicateAtResult>;
|
|
19829
|
+
/**
|
|
19830
|
+
* Acquires or releases the queued-lane drain pause.
|
|
19831
|
+
*
|
|
19832
|
+
* @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.
|
|
19833
|
+
*/
|
|
19834
|
+
setDrainPaused: (params: QueueSetDrainPausedRequest) => Promise<void>;
|
|
19835
|
+
/**
|
|
19836
|
+
* Moves an addressable queued message into the live turn's steering lane.
|
|
19837
|
+
*
|
|
19838
|
+
* @param params Parameters for steering a queued message into a live turn.
|
|
19839
|
+
*
|
|
19840
|
+
* @returns Result of trying to steer a queued message into a live turn.
|
|
19841
|
+
*/
|
|
19842
|
+
sendNow: (params: QueueSendNowRequest) => Promise<QueueSendNowResult>;
|
|
17645
19843
|
/**
|
|
17646
19844
|
* Removes the most recently queued user-facing item (LIFO).
|
|
17647
19845
|
*
|
|
@@ -17696,6 +19894,17 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
17696
19894
|
getMetrics: () => Promise<UsageGetMetricsResult>;
|
|
17697
19895
|
};
|
|
17698
19896
|
/** @experimental */
|
|
19897
|
+
limitPrediction: {
|
|
19898
|
+
/**
|
|
19899
|
+
* 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.
|
|
19900
|
+
*
|
|
19901
|
+
* @param params Parameters for predicting an AI-credit session limit. Omitting `modelId` uses the session's currently selected model.
|
|
19902
|
+
*
|
|
19903
|
+
* @returns Prediction result. Available results include prediction details; unavailable results include an explicit reason.
|
|
19904
|
+
*/
|
|
19905
|
+
predict: (params?: SessionLimitPredictionPredictRequest) => Promise<SessionLimitPredictionResult>;
|
|
19906
|
+
};
|
|
19907
|
+
/** @experimental */
|
|
17699
19908
|
remote: {
|
|
17700
19909
|
/**
|
|
17701
19910
|
* Enables remote session export or steering.
|
|
@@ -17869,13 +20078,21 @@ export interface SessionFsHandler {
|
|
|
17869
20078
|
*/
|
|
17870
20079
|
rename(params: SessionFsRenameRequest): Promise<SessionFsError | undefined>;
|
|
17871
20080
|
/**
|
|
17872
|
-
* Executes a SQLite query against the per-session database.
|
|
20081
|
+
* Executes a SQLite query against the per-session database. Providers apply busy handling for every call.
|
|
17873
20082
|
*
|
|
17874
|
-
* @param params SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database.
|
|
20083
|
+
* @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.
|
|
17875
20084
|
*
|
|
17876
20085
|
* @returns Query results including rows, columns, and rows affected, or a filesystem error if execution failed.
|
|
17877
20086
|
*/
|
|
17878
20087
|
sqliteQuery(params: SessionFsSqliteQueryRequest): Promise<SessionFsSqliteQueryResult>;
|
|
20088
|
+
/**
|
|
20089
|
+
* Executes SQLite statements atomically on the provider-owned connection.
|
|
20090
|
+
*
|
|
20091
|
+
* @param params Statements to execute atomically. Providers apply busy handling for every call.
|
|
20092
|
+
*
|
|
20093
|
+
* @returns Per-statement results, or a classified transaction error.
|
|
20094
|
+
*/
|
|
20095
|
+
sqliteTransaction(params: SessionFsSqliteTransactionRequest): Promise<SessionFsSqliteTransactionResult>;
|
|
17879
20096
|
/**
|
|
17880
20097
|
* Checks whether the per-session SQLite database already exists, without creating it.
|
|
17881
20098
|
*
|