@github/copilot-sdk 1.0.0-beta.8 → 1.0.0
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 +25 -10
- package/dist/canvas.d.ts +26 -3
- package/dist/cjs/client.js +273 -42
- package/dist/cjs/extension.js +3 -1
- package/dist/cjs/generated/rpc.js +83 -17
- package/dist/cjs/index.js +5 -0
- package/dist/cjs/session.js +34 -5
- package/dist/cjs/toolSet.js +107 -0
- package/dist/client.d.ts +17 -25
- package/dist/client.js +273 -42
- package/dist/extension.d.ts +1 -1
- package/dist/extension.js +3 -1
- package/dist/generated/rpc.d.ts +949 -303
- package/dist/generated/rpc.js +83 -17
- package/dist/generated/session-events.d.ts +267 -22
- package/dist/index.d.ts +3 -2
- package/dist/index.js +3 -0
- package/dist/session.d.ts +9 -5
- package/dist/session.js +34 -5
- package/dist/toolSet.d.ts +75 -0
- package/dist/toolSet.js +82 -0
- package/dist/types.d.ts +306 -8
- package/docs/agent-author.md +31 -7
- package/docs/examples.md +26 -16
- package/package.json +3 -3
package/dist/generated/rpc.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Generated from: api.schema.json
|
|
4
4
|
*/
|
|
5
5
|
import type { MessageConnection } from "vscode-jsonrpc/node.js";
|
|
6
|
-
import type { AbortReason, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval } from "./session-events.js";
|
|
6
|
+
import type { AbortReason, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval } from "./session-events.js";
|
|
7
7
|
/**
|
|
8
8
|
* Where the agent definition was loaded from
|
|
9
9
|
*
|
|
@@ -24,6 +24,136 @@ export type AgentInfoSource =
|
|
|
24
24
|
| "plugin"
|
|
25
25
|
/** Agent built into the Copilot runtime. */
|
|
26
26
|
| "builtin";
|
|
27
|
+
/**
|
|
28
|
+
* Process kind tag for the registry entry
|
|
29
|
+
*
|
|
30
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
31
|
+
* via the `definition` "AgentRegistryLiveTargetEntryKind".
|
|
32
|
+
*/
|
|
33
|
+
/** @experimental */
|
|
34
|
+
export type AgentRegistryLiveTargetEntryKind =
|
|
35
|
+
/** Interactive Copilot CLI exposing a UI server (legacy/normal CLI process) */
|
|
36
|
+
"ui-server"
|
|
37
|
+
/** Headless `--server --managed-server` child spawned by a controller */
|
|
38
|
+
| "managed-server";
|
|
39
|
+
/**
|
|
40
|
+
* Coarse lifecycle status of the foreground session
|
|
41
|
+
*
|
|
42
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
43
|
+
* via the `definition` "AgentRegistryLiveTargetEntryStatus".
|
|
44
|
+
*/
|
|
45
|
+
/** @experimental */
|
|
46
|
+
export type AgentRegistryLiveTargetEntryStatus =
|
|
47
|
+
/** Session is actively processing a turn */
|
|
48
|
+
"working"
|
|
49
|
+
/** Session is idle, waiting for input */
|
|
50
|
+
| "waiting"
|
|
51
|
+
/** Last turn completed successfully */
|
|
52
|
+
| "done"
|
|
53
|
+
/** Session needs user attention (see attentionKind for the specific reason) */
|
|
54
|
+
| "attention";
|
|
55
|
+
/**
|
|
56
|
+
* Kind of attention required when status === "attention". Meaningful only when status === "attention".
|
|
57
|
+
*
|
|
58
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
59
|
+
* via the `definition` "AgentRegistryLiveTargetEntryAttentionKind".
|
|
60
|
+
*/
|
|
61
|
+
/** @experimental */
|
|
62
|
+
export type AgentRegistryLiveTargetEntryAttentionKind =
|
|
63
|
+
/** Session is blocked on an unrecoverable error */
|
|
64
|
+
"error"
|
|
65
|
+
/** Session is waiting for a tool-permission decision */
|
|
66
|
+
| "permission"
|
|
67
|
+
/** Session is waiting for the user to approve or reject a plan */
|
|
68
|
+
| "exit_plan"
|
|
69
|
+
/** Session is waiting on an elicitation prompt */
|
|
70
|
+
| "elicitation"
|
|
71
|
+
/** Session is waiting for free-form user input */
|
|
72
|
+
| "user_input";
|
|
73
|
+
/**
|
|
74
|
+
* How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done from done_cancelled.
|
|
75
|
+
*
|
|
76
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
77
|
+
* via the `definition` "AgentRegistryLiveTargetEntryLastTerminalEvent".
|
|
78
|
+
*/
|
|
79
|
+
/** @experimental */
|
|
80
|
+
export type AgentRegistryLiveTargetEntryLastTerminalEvent =
|
|
81
|
+
/** Last turn ended cleanly (model returned a final assistant message) */
|
|
82
|
+
"turn_end"
|
|
83
|
+
/** Last turn was aborted (e.g. user interrupted) */
|
|
84
|
+
| "abort";
|
|
85
|
+
/**
|
|
86
|
+
* Categorized reason for log-open failure
|
|
87
|
+
*
|
|
88
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
89
|
+
* via the `definition` "AgentRegistryLogCaptureOpenErrorReason".
|
|
90
|
+
*/
|
|
91
|
+
/** @experimental */
|
|
92
|
+
export type AgentRegistryLogCaptureOpenErrorReason =
|
|
93
|
+
/** Filesystem permission denied opening the log file */
|
|
94
|
+
"permission"
|
|
95
|
+
/** No space left on device */
|
|
96
|
+
| "disk_full"
|
|
97
|
+
/** Other / uncategorized open failure */
|
|
98
|
+
| "other";
|
|
99
|
+
/**
|
|
100
|
+
* Permission posture for the new session. 'yolo' requires the controller-local session to currently be in allow-all mode.
|
|
101
|
+
*
|
|
102
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
103
|
+
* via the `definition` "AgentRegistrySpawnPermissionMode".
|
|
104
|
+
*/
|
|
105
|
+
/** @experimental */
|
|
106
|
+
export type AgentRegistrySpawnPermissionMode =
|
|
107
|
+
/** Standard permission posture (prompts for each request) */
|
|
108
|
+
"default"
|
|
109
|
+
/** Full allow-all (requires the controller-local session to currently be in allow-all mode) */
|
|
110
|
+
| "yolo";
|
|
111
|
+
/**
|
|
112
|
+
* Outcome of an agentRegistry.spawn call.
|
|
113
|
+
*
|
|
114
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
115
|
+
* via the `definition` "AgentRegistrySpawnResult".
|
|
116
|
+
*/
|
|
117
|
+
/** @experimental */
|
|
118
|
+
export type AgentRegistrySpawnResult = AgentRegistrySpawnSpawned | AgentRegistrySpawnError | AgentRegistrySpawnRegistryTimeout | AgentRegistrySpawnValidationError;
|
|
119
|
+
/**
|
|
120
|
+
* Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by reason without leaking raw paths or agent/model names.
|
|
121
|
+
*
|
|
122
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
123
|
+
* via the `definition` "AgentRegistrySpawnValidationErrorReason".
|
|
124
|
+
*/
|
|
125
|
+
/** @experimental */
|
|
126
|
+
export type AgentRegistrySpawnValidationErrorReason =
|
|
127
|
+
/** Provided cwd does not exist on disk */
|
|
128
|
+
"cwd-not-found"
|
|
129
|
+
/** Provided cwd exists but is not a directory */
|
|
130
|
+
| "cwd-not-directory"
|
|
131
|
+
/** Session name failed validateSessionName */
|
|
132
|
+
| "invalid-name"
|
|
133
|
+
/** Requested agent name was not found in builtin or custom agents */
|
|
134
|
+
| "unknown-agent"
|
|
135
|
+
/** Requested model is not available to this session */
|
|
136
|
+
| "unknown-model"
|
|
137
|
+
/** Caller asked for permissionMode='yolo' but the controller is not currently in allow-all mode */
|
|
138
|
+
| "yolo-not-allowed";
|
|
139
|
+
/**
|
|
140
|
+
* Which parameter field was invalid. Omitted when the rejection is not field-specific.
|
|
141
|
+
*
|
|
142
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
143
|
+
* via the `definition` "AgentRegistrySpawnValidationErrorField".
|
|
144
|
+
*/
|
|
145
|
+
/** @experimental */
|
|
146
|
+
export type AgentRegistrySpawnValidationErrorField =
|
|
147
|
+
/** The cwd parameter */
|
|
148
|
+
"cwd"
|
|
149
|
+
/** The session name parameter */
|
|
150
|
+
| "name"
|
|
151
|
+
/** The agentName parameter */
|
|
152
|
+
| "agentName"
|
|
153
|
+
/** The model parameter */
|
|
154
|
+
| "model"
|
|
155
|
+
/** The permissionMode parameter */
|
|
156
|
+
| "permissionMode";
|
|
27
157
|
/**
|
|
28
158
|
* The new auth credentials to install on the session. When omitted or `undefined`, the call is a no-op and the session's existing credentials are preserved. The runtime stores the value verbatim and uses it for outbound model/API requests; it does NOT re-validate or re-fetch the associated Copilot user response. Several variants carry secret material; treat this method's params as containing secrets at rest and in transit.
|
|
29
159
|
*
|
|
@@ -260,7 +390,7 @@ export type FilterMapping = {
|
|
|
260
390
|
* via the `definition` "InstalledPluginSource".
|
|
261
391
|
*/
|
|
262
392
|
/** @experimental */
|
|
263
|
-
export type InstalledPluginSource = string |
|
|
393
|
+
export type InstalledPluginSource = string | InstalledPluginSourceGitHub | InstalledPluginSourceUrl | InstalledPluginSourceLocal;
|
|
264
394
|
/**
|
|
265
395
|
* Category of instruction source — used for merge logic
|
|
266
396
|
*
|
|
@@ -429,23 +559,12 @@ export type McpAppsSetHostContextDetailsPlatform =
|
|
|
429
559
|
*/
|
|
430
560
|
export type McpServerConfig = McpServerConfigStdio | McpServerConfigHttp;
|
|
431
561
|
/**
|
|
432
|
-
*
|
|
562
|
+
* Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.
|
|
433
563
|
*
|
|
434
564
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
435
|
-
* via the `definition` "
|
|
565
|
+
* via the `definition` "McpServerAuthConfig".
|
|
436
566
|
*/
|
|
437
|
-
export type
|
|
438
|
-
[k: string]: unknown | undefined;
|
|
439
|
-
};
|
|
440
|
-
/**
|
|
441
|
-
* Authentication configuration for this server.
|
|
442
|
-
*
|
|
443
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
444
|
-
* via the `definition` "McpServerConfigStdioAuth".
|
|
445
|
-
*/
|
|
446
|
-
export type McpServerConfigStdioAuth = boolean | {
|
|
447
|
-
[k: string]: unknown | undefined;
|
|
448
|
-
};
|
|
567
|
+
export type McpServerAuthConfig = boolean | McpServerAuthConfigRedirectPort;
|
|
449
568
|
/**
|
|
450
569
|
* Remote transport type. Defaults to "http" when omitted.
|
|
451
570
|
*
|
|
@@ -457,15 +576,6 @@ export type McpServerConfigHttpType =
|
|
|
457
576
|
"http"
|
|
458
577
|
/** Server-Sent Events transport. */
|
|
459
578
|
| "sse";
|
|
460
|
-
/**
|
|
461
|
-
* OIDC token configuration. When truthy, a token is automatically gathered.
|
|
462
|
-
*
|
|
463
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
464
|
-
* via the `definition` "McpServerConfigHttpOidc".
|
|
465
|
-
*/
|
|
466
|
-
export type McpServerConfigHttpOidc = boolean | {
|
|
467
|
-
[k: string]: unknown | undefined;
|
|
468
|
-
};
|
|
469
579
|
/**
|
|
470
580
|
* OAuth grant type to use when authenticating to the remote MCP server.
|
|
471
581
|
*
|
|
@@ -527,6 +637,10 @@ export type SessionContextInfo = {
|
|
|
527
637
|
* Tokens consumed by tool definitions sent to the model (excludes deferred tools)
|
|
528
638
|
*/
|
|
529
639
|
toolDefinitionsTokens: number;
|
|
640
|
+
/**
|
|
641
|
+
* Tokens consumed by MCP tool definitions (subset of toolDefinitionsTokens, excludes deferred tools)
|
|
642
|
+
*/
|
|
643
|
+
mcpToolsTokens: number;
|
|
530
644
|
/**
|
|
531
645
|
* Sum of system, conversation and tool-definition tokens
|
|
532
646
|
*/
|
|
@@ -540,7 +654,7 @@ export type SessionContextInfo = {
|
|
|
540
654
|
*/
|
|
541
655
|
compactionThreshold: number;
|
|
542
656
|
/**
|
|
543
|
-
* Total context limit for /context display
|
|
657
|
+
* Total context limit for /context display: promptTokenLimit + outputTokenLimit (the model's full max_output_tokens reserved on top of the prompt budget).
|
|
544
658
|
*/
|
|
545
659
|
limit: number;
|
|
546
660
|
/**
|
|
@@ -639,6 +753,18 @@ export type OptionsUpdateEnvValueMode =
|
|
|
639
753
|
"direct"
|
|
640
754
|
/** Resolve MCP server environment values from host-side references. */
|
|
641
755
|
| "indirect";
|
|
756
|
+
/**
|
|
757
|
+
* Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set.
|
|
758
|
+
*
|
|
759
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
760
|
+
* via the `definition` "OptionsUpdateToolFilterPrecedence".
|
|
761
|
+
*/
|
|
762
|
+
/** @experimental */
|
|
763
|
+
export type OptionsUpdateToolFilterPrecedence =
|
|
764
|
+
/** If availableTools is set, it is the only constraint that applies (excludedTools is ignored). Preserves CLI / pre-existing client behavior. Default. */
|
|
765
|
+
"available"
|
|
766
|
+
/** A tool is enabled if and only if it matches the allowlist (or the allowlist is unset) AND it does not match the denylist. Makes 'all except X' expressible by combining the two lists. */
|
|
767
|
+
| "excluded";
|
|
642
768
|
/**
|
|
643
769
|
* The client's response to the pending permission prompt
|
|
644
770
|
*
|
|
@@ -707,6 +833,22 @@ export type PermissionsModifyRulesScope =
|
|
|
707
833
|
"session"
|
|
708
834
|
/** Persist the rule change for this project location. */
|
|
709
835
|
| "location";
|
|
836
|
+
/**
|
|
837
|
+
* Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.
|
|
838
|
+
*
|
|
839
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
840
|
+
* via the `definition` "PermissionsSetAllowAllSource".
|
|
841
|
+
*/
|
|
842
|
+
/** @experimental */
|
|
843
|
+
export type PermissionsSetAllowAllSource =
|
|
844
|
+
/** Allow-all was enabled from a CLI command-line flag. */
|
|
845
|
+
"cli_flag"
|
|
846
|
+
/** Allow-all was enabled by a slash command. */
|
|
847
|
+
| "slash_command"
|
|
848
|
+
/** Allow-all was enabled by confirming autopilot behavior. */
|
|
849
|
+
| "autopilot_confirmation"
|
|
850
|
+
/** Allow-all was enabled through an RPC caller. */
|
|
851
|
+
| "rpc";
|
|
710
852
|
/**
|
|
711
853
|
* Optional source for allow-all telemetry. Defaults to `rpc` when omitted for SDK callers.
|
|
712
854
|
*
|
|
@@ -723,6 +865,28 @@ export type PermissionsSetApproveAllSource =
|
|
|
723
865
|
| "autopilot_confirmation"
|
|
724
866
|
/** Allow-all was enabled through an RPC caller. */
|
|
725
867
|
| "rpc";
|
|
868
|
+
/**
|
|
869
|
+
* Schema for the `PushAttachment` type.
|
|
870
|
+
*
|
|
871
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
872
|
+
* via the `definition` "PushAttachment".
|
|
873
|
+
*/
|
|
874
|
+
/** @experimental */
|
|
875
|
+
export type PushAttachment = PushAttachmentFile | PushAttachmentDirectory | PushAttachmentSelection | PushAttachmentGitHubReference | PushAttachmentBlob | ExtensionContextPushInput;
|
|
876
|
+
/**
|
|
877
|
+
* Type of GitHub reference
|
|
878
|
+
*
|
|
879
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
880
|
+
* via the `definition` "PushAttachmentGitHubReferenceType".
|
|
881
|
+
*/
|
|
882
|
+
/** @experimental */
|
|
883
|
+
export type PushAttachmentGitHubReferenceType =
|
|
884
|
+
/** GitHub issue reference. */
|
|
885
|
+
"issue"
|
|
886
|
+
/** GitHub pull request reference. */
|
|
887
|
+
| "pr"
|
|
888
|
+
/** GitHub discussion reference. */
|
|
889
|
+
| "discussion";
|
|
726
890
|
/**
|
|
727
891
|
* Whether this item is a queued user message or a queued slash command / model change
|
|
728
892
|
*
|
|
@@ -765,28 +929,6 @@ export type SendAgentMode =
|
|
|
765
929
|
| "autopilot"
|
|
766
930
|
/** The agent is in shell-focused UI mode. */
|
|
767
931
|
| "shell";
|
|
768
|
-
/**
|
|
769
|
-
* A user message attachment — a file, directory, code selection, blob, or GitHub reference
|
|
770
|
-
*
|
|
771
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
772
|
-
* via the `definition` "SendAttachment".
|
|
773
|
-
*/
|
|
774
|
-
/** @experimental */
|
|
775
|
-
export type SendAttachment = SendAttachmentFile | SendAttachmentDirectory | SendAttachmentSelection | SendAttachmentGithubReference | SendAttachmentBlob;
|
|
776
|
-
/**
|
|
777
|
-
* Type of GitHub reference
|
|
778
|
-
*
|
|
779
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
780
|
-
* via the `definition` "SendAttachmentGithubReferenceType".
|
|
781
|
-
*/
|
|
782
|
-
/** @experimental */
|
|
783
|
-
export type SendAttachmentGithubReferenceType =
|
|
784
|
-
/** GitHub issue reference. */
|
|
785
|
-
"issue"
|
|
786
|
-
/** GitHub pull request reference. */
|
|
787
|
-
| "pr"
|
|
788
|
-
/** GitHub discussion reference. */
|
|
789
|
-
| "discussion";
|
|
790
932
|
/**
|
|
791
933
|
* How to deliver the message. `enqueue` (default) appends to the message queue. `immediate` interjects during an in-progress turn.
|
|
792
934
|
*
|
|
@@ -867,7 +1009,7 @@ export type SessionFsSqliteQueryType =
|
|
|
867
1009
|
* via the `definition` "SessionInstalledPluginSource".
|
|
868
1010
|
*/
|
|
869
1011
|
/** @experimental */
|
|
870
|
-
export type SessionInstalledPluginSource = string |
|
|
1012
|
+
export type SessionInstalledPluginSource = string | SessionInstalledPluginSourceGitHub | SessionInstalledPluginSourceUrl | SessionInstalledPluginSourceLocal;
|
|
871
1013
|
/**
|
|
872
1014
|
* Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags).
|
|
873
1015
|
*
|
|
@@ -1297,6 +1439,204 @@ export interface AgentList {
|
|
|
1297
1439
|
*/
|
|
1298
1440
|
agents: AgentInfo[];
|
|
1299
1441
|
}
|
|
1442
|
+
/**
|
|
1443
|
+
* Full registry entry for the spawned child. Lets the controller call `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a TOCTOU window).
|
|
1444
|
+
*
|
|
1445
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1446
|
+
* via the `definition` "AgentRegistryLiveTargetEntry".
|
|
1447
|
+
*/
|
|
1448
|
+
/** @experimental */
|
|
1449
|
+
export interface AgentRegistryLiveTargetEntry {
|
|
1450
|
+
/**
|
|
1451
|
+
* Registry entry schema version (1 = ui-server, 2 = managed-server)
|
|
1452
|
+
*/
|
|
1453
|
+
schemaVersion: number;
|
|
1454
|
+
kind: AgentRegistryLiveTargetEntryKind;
|
|
1455
|
+
/**
|
|
1456
|
+
* Operating-system pid of the process owning this entry
|
|
1457
|
+
*/
|
|
1458
|
+
pid: number;
|
|
1459
|
+
/**
|
|
1460
|
+
* Bind host for the entry's JSON-RPC server
|
|
1461
|
+
*/
|
|
1462
|
+
host: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* TCP port the entry's JSON-RPC server is listening on
|
|
1465
|
+
*/
|
|
1466
|
+
port: number;
|
|
1467
|
+
/**
|
|
1468
|
+
* Session ID of the foreground session for this entry
|
|
1469
|
+
*/
|
|
1470
|
+
sessionId?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* Friendly session name (when set)
|
|
1473
|
+
*/
|
|
1474
|
+
sessionName?: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* Working directory of the session (when known)
|
|
1477
|
+
*/
|
|
1478
|
+
cwd?: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* Git branch of the session (when known)
|
|
1481
|
+
*/
|
|
1482
|
+
branch?: string;
|
|
1483
|
+
/**
|
|
1484
|
+
* Model identifier currently selected for the session
|
|
1485
|
+
*/
|
|
1486
|
+
model?: string;
|
|
1487
|
+
status?: AgentRegistryLiveTargetEntryStatus;
|
|
1488
|
+
attentionKind?: AgentRegistryLiveTargetEntryAttentionKind;
|
|
1489
|
+
/**
|
|
1490
|
+
* Monotonic per-publisher revision counter incremented on every status update. Lets watchers detect transient flips.
|
|
1491
|
+
*/
|
|
1492
|
+
statusRevision?: number;
|
|
1493
|
+
lastTerminalEvent?: AgentRegistryLiveTargetEntryLastTerminalEvent;
|
|
1494
|
+
/**
|
|
1495
|
+
* ISO 8601 timestamp captured at registration
|
|
1496
|
+
*/
|
|
1497
|
+
startedAt: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* Copilot CLI version that wrote the entry
|
|
1500
|
+
*/
|
|
1501
|
+
copilotVersion: string;
|
|
1502
|
+
/**
|
|
1503
|
+
* Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness)
|
|
1504
|
+
*/
|
|
1505
|
+
lastSeenMs: number;
|
|
1506
|
+
}
|
|
1507
|
+
/**
|
|
1508
|
+
* Per-spawn log-capture outcome; populated from spawnLiveTarget.
|
|
1509
|
+
*
|
|
1510
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1511
|
+
* via the `definition` "AgentRegistryLogCapture".
|
|
1512
|
+
*/
|
|
1513
|
+
/** @experimental */
|
|
1514
|
+
export interface AgentRegistryLogCapture {
|
|
1515
|
+
/**
|
|
1516
|
+
* Whether per-spawn log capture is on (false when env-disabled or open failed)
|
|
1517
|
+
*/
|
|
1518
|
+
enabled: boolean;
|
|
1519
|
+
/**
|
|
1520
|
+
* Absolute path to the per-spawn log file (only set when enabled)
|
|
1521
|
+
*/
|
|
1522
|
+
path?: string;
|
|
1523
|
+
/**
|
|
1524
|
+
* Human-readable open failure message (only set when enabled === false AND the env-disable opt-out was NOT used)
|
|
1525
|
+
*/
|
|
1526
|
+
openError?: string;
|
|
1527
|
+
openErrorReason?: AgentRegistryLogCaptureOpenErrorReason;
|
|
1528
|
+
}
|
|
1529
|
+
/**
|
|
1530
|
+
* `child_process.spawn` itself failed before the child entered the registry.
|
|
1531
|
+
*
|
|
1532
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1533
|
+
* via the `definition` "AgentRegistrySpawnError".
|
|
1534
|
+
*/
|
|
1535
|
+
/** @experimental */
|
|
1536
|
+
export interface AgentRegistrySpawnError {
|
|
1537
|
+
/**
|
|
1538
|
+
* Discriminator: child_process.spawn itself failed
|
|
1539
|
+
*/
|
|
1540
|
+
kind: "spawn-error";
|
|
1541
|
+
/**
|
|
1542
|
+
* Human-readable error message
|
|
1543
|
+
*/
|
|
1544
|
+
message: string;
|
|
1545
|
+
/**
|
|
1546
|
+
* Underlying errno code (e.g. ENOENT, EACCES) when available
|
|
1547
|
+
*/
|
|
1548
|
+
code?: string;
|
|
1549
|
+
}
|
|
1550
|
+
/**
|
|
1551
|
+
* Spawn succeeded but the child did not publish a matching managed-server entry within the timeout.
|
|
1552
|
+
*
|
|
1553
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1554
|
+
* via the `definition` "AgentRegistrySpawnRegistryTimeout".
|
|
1555
|
+
*/
|
|
1556
|
+
/** @experimental */
|
|
1557
|
+
export interface AgentRegistrySpawnRegistryTimeout {
|
|
1558
|
+
/**
|
|
1559
|
+
* Discriminator: spawn succeeded but child never registered
|
|
1560
|
+
*/
|
|
1561
|
+
kind: "registry-timeout";
|
|
1562
|
+
/**
|
|
1563
|
+
* Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance)
|
|
1564
|
+
*/
|
|
1565
|
+
childPid: number;
|
|
1566
|
+
logCapture?: AgentRegistryLogCapture;
|
|
1567
|
+
}
|
|
1568
|
+
/**
|
|
1569
|
+
* Inputs to spawn a managed-server child via the controller's spawn delegate.
|
|
1570
|
+
*
|
|
1571
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1572
|
+
* via the `definition` "AgentRegistrySpawnRequest".
|
|
1573
|
+
*/
|
|
1574
|
+
/** @experimental */
|
|
1575
|
+
export interface AgentRegistrySpawnRequest {
|
|
1576
|
+
/**
|
|
1577
|
+
* Working directory for the spawned child (must be an existing directory)
|
|
1578
|
+
*/
|
|
1579
|
+
cwd: string;
|
|
1580
|
+
/**
|
|
1581
|
+
* Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own default.
|
|
1582
|
+
*/
|
|
1583
|
+
agentName?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* Model identifier to apply to the new session
|
|
1586
|
+
*/
|
|
1587
|
+
model?: string;
|
|
1588
|
+
/**
|
|
1589
|
+
* Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing whitespace, <=100 chars, no control chars, no double quotes.
|
|
1590
|
+
*/
|
|
1591
|
+
name?: string;
|
|
1592
|
+
permissionMode?: AgentRegistrySpawnPermissionMode;
|
|
1593
|
+
/**
|
|
1594
|
+
* Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it post-attach via the standard LocalRpcSession.send path).
|
|
1595
|
+
*/
|
|
1596
|
+
initialPrompt?: string;
|
|
1597
|
+
}
|
|
1598
|
+
/**
|
|
1599
|
+
* Managed-server child was spawned and registered successfully.
|
|
1600
|
+
*
|
|
1601
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1602
|
+
* via the `definition` "AgentRegistrySpawnSpawned".
|
|
1603
|
+
*/
|
|
1604
|
+
/** @experimental */
|
|
1605
|
+
export interface AgentRegistrySpawnSpawned {
|
|
1606
|
+
/**
|
|
1607
|
+
* Discriminator: managed-server child spawned successfully
|
|
1608
|
+
*/
|
|
1609
|
+
kind: "spawned";
|
|
1610
|
+
entry: AgentRegistryLiveTargetEntry;
|
|
1611
|
+
/**
|
|
1612
|
+
* Whether the delegate already sent the initial prompt. Always omitted in the current wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send path.
|
|
1613
|
+
*/
|
|
1614
|
+
initialPromptSent?: boolean;
|
|
1615
|
+
/**
|
|
1616
|
+
* If the delegate attempted to send the initial prompt and failed, the categorized error message.
|
|
1617
|
+
*/
|
|
1618
|
+
initialPromptError?: string;
|
|
1619
|
+
logCapture?: AgentRegistryLogCapture;
|
|
1620
|
+
}
|
|
1621
|
+
/**
|
|
1622
|
+
* Synchronous pre-validation rejected the spawn request.
|
|
1623
|
+
*
|
|
1624
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1625
|
+
* via the `definition` "AgentRegistrySpawnValidationError".
|
|
1626
|
+
*/
|
|
1627
|
+
/** @experimental */
|
|
1628
|
+
export interface AgentRegistrySpawnValidationError {
|
|
1629
|
+
/**
|
|
1630
|
+
* Discriminator: synchronous pre-validation rejected the request
|
|
1631
|
+
*/
|
|
1632
|
+
kind: "validation-error";
|
|
1633
|
+
reason: AgentRegistrySpawnValidationErrorReason;
|
|
1634
|
+
field?: AgentRegistrySpawnValidationErrorField;
|
|
1635
|
+
/**
|
|
1636
|
+
* Human-readable explanation; safe to surface in the UI banner. Never logged to unrestricted telemetry.
|
|
1637
|
+
*/
|
|
1638
|
+
message: string;
|
|
1639
|
+
}
|
|
1300
1640
|
/**
|
|
1301
1641
|
* Custom agents available to the session after reloading definitions from disk.
|
|
1302
1642
|
*
|
|
@@ -1333,6 +1673,36 @@ export interface AgentSelectRequest {
|
|
|
1333
1673
|
export interface AgentSelectResult {
|
|
1334
1674
|
agent: AgentInfo;
|
|
1335
1675
|
}
|
|
1676
|
+
/**
|
|
1677
|
+
* Indicates whether the operation succeeded and reports the post-mutation state.
|
|
1678
|
+
*
|
|
1679
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1680
|
+
* via the `definition` "AllowAllPermissionSetResult".
|
|
1681
|
+
*/
|
|
1682
|
+
/** @experimental */
|
|
1683
|
+
export interface AllowAllPermissionSetResult {
|
|
1684
|
+
/**
|
|
1685
|
+
* Whether the operation succeeded
|
|
1686
|
+
*/
|
|
1687
|
+
success: boolean;
|
|
1688
|
+
/**
|
|
1689
|
+
* Authoritative allow-all state after the mutation
|
|
1690
|
+
*/
|
|
1691
|
+
enabled: boolean;
|
|
1692
|
+
}
|
|
1693
|
+
/**
|
|
1694
|
+
* Current full allow-all permission state.
|
|
1695
|
+
*
|
|
1696
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1697
|
+
* via the `definition` "AllowAllPermissionState".
|
|
1698
|
+
*/
|
|
1699
|
+
/** @experimental */
|
|
1700
|
+
export interface AllowAllPermissionState {
|
|
1701
|
+
/**
|
|
1702
|
+
* Whether full allow-all permissions are currently active
|
|
1703
|
+
*/
|
|
1704
|
+
enabled: boolean;
|
|
1705
|
+
}
|
|
1336
1706
|
/**
|
|
1337
1707
|
* Schema for the `ApiKeyAuthInfo` type.
|
|
1338
1708
|
*
|
|
@@ -1675,73 +2045,73 @@ export interface CanvasJsonSchema {
|
|
|
1675
2045
|
[k: string]: unknown | undefined;
|
|
1676
2046
|
}
|
|
1677
2047
|
/**
|
|
1678
|
-
* Canvas
|
|
2048
|
+
* Canvas action invocation parameters.
|
|
1679
2049
|
*
|
|
1680
2050
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1681
|
-
* via the `definition` "
|
|
2051
|
+
* via the `definition` "CanvasActionInvokeRequest".
|
|
1682
2052
|
*/
|
|
1683
2053
|
/** @experimental */
|
|
1684
|
-
export interface
|
|
2054
|
+
export interface CanvasActionInvokeRequest {
|
|
1685
2055
|
/**
|
|
1686
2056
|
* Open canvas instance identifier
|
|
1687
2057
|
*/
|
|
1688
2058
|
instanceId: string;
|
|
2059
|
+
/**
|
|
2060
|
+
* Action name to invoke
|
|
2061
|
+
*/
|
|
2062
|
+
actionName: string;
|
|
2063
|
+
/**
|
|
2064
|
+
* Action input
|
|
2065
|
+
*/
|
|
2066
|
+
input?: {
|
|
2067
|
+
[k: string]: unknown | undefined;
|
|
2068
|
+
};
|
|
1689
2069
|
}
|
|
1690
2070
|
/**
|
|
1691
|
-
*
|
|
2071
|
+
* Provider-supplied action result.
|
|
1692
2072
|
*
|
|
1693
2073
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1694
|
-
* via the `definition` "
|
|
2074
|
+
* via the `definition` "CanvasActionInvokeResult".
|
|
1695
2075
|
*/
|
|
1696
2076
|
/** @experimental */
|
|
1697
|
-
export interface
|
|
1698
|
-
|
|
2077
|
+
export interface CanvasActionInvokeResult {
|
|
2078
|
+
[k: string]: unknown | undefined;
|
|
1699
2079
|
}
|
|
1700
2080
|
/**
|
|
1701
|
-
*
|
|
2081
|
+
* Canvas close parameters.
|
|
1702
2082
|
*
|
|
1703
2083
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1704
|
-
* via the `definition` "
|
|
2084
|
+
* via the `definition` "CanvasCloseRequest".
|
|
1705
2085
|
*/
|
|
1706
2086
|
/** @experimental */
|
|
1707
|
-
export interface
|
|
2087
|
+
export interface CanvasCloseRequest {
|
|
1708
2088
|
/**
|
|
1709
|
-
*
|
|
2089
|
+
* Open canvas instance identifier
|
|
1710
2090
|
*/
|
|
1711
|
-
|
|
2091
|
+
instanceId: string;
|
|
1712
2092
|
}
|
|
1713
2093
|
/**
|
|
1714
|
-
*
|
|
2094
|
+
* Host context supplied by the runtime.
|
|
1715
2095
|
*
|
|
1716
2096
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1717
|
-
* via the `definition` "
|
|
2097
|
+
* via the `definition` "CanvasHostContext".
|
|
1718
2098
|
*/
|
|
1719
|
-
/** @experimental */
|
|
1720
|
-
export interface
|
|
1721
|
-
|
|
1722
|
-
* Open canvas instance identifier
|
|
1723
|
-
*/
|
|
1724
|
-
instanceId: string;
|
|
1725
|
-
/**
|
|
1726
|
-
* Action name to invoke
|
|
1727
|
-
*/
|
|
1728
|
-
actionName: string;
|
|
1729
|
-
/**
|
|
1730
|
-
* Action input
|
|
1731
|
-
*/
|
|
1732
|
-
input?: {
|
|
1733
|
-
[k: string]: unknown | undefined;
|
|
1734
|
-
};
|
|
2099
|
+
/** @experimental */
|
|
2100
|
+
export interface CanvasHostContext {
|
|
2101
|
+
capabilities?: CanvasHostContextCapabilities;
|
|
1735
2102
|
}
|
|
1736
2103
|
/**
|
|
1737
|
-
*
|
|
2104
|
+
* Host capabilities
|
|
1738
2105
|
*
|
|
1739
2106
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1740
|
-
* via the `definition` "
|
|
2107
|
+
* via the `definition` "CanvasHostContextCapabilities".
|
|
1741
2108
|
*/
|
|
1742
2109
|
/** @experimental */
|
|
1743
|
-
export interface
|
|
1744
|
-
|
|
2110
|
+
export interface CanvasHostContextCapabilities {
|
|
2111
|
+
/**
|
|
2112
|
+
* Whether canvas rendering is supported
|
|
2113
|
+
*/
|
|
2114
|
+
canvases?: boolean;
|
|
1745
2115
|
}
|
|
1746
2116
|
/**
|
|
1747
2117
|
* Declared canvases available in this session.
|
|
@@ -1903,6 +2273,20 @@ export interface CanvasProviderCloseRequest {
|
|
|
1903
2273
|
*/
|
|
1904
2274
|
instanceId: string;
|
|
1905
2275
|
host?: CanvasHostContext;
|
|
2276
|
+
session?: CanvasSessionContext;
|
|
2277
|
+
}
|
|
2278
|
+
/**
|
|
2279
|
+
* Session context supplied by the runtime.
|
|
2280
|
+
*
|
|
2281
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2282
|
+
* via the `definition` "CanvasSessionContext".
|
|
2283
|
+
*/
|
|
2284
|
+
/** @experimental */
|
|
2285
|
+
export interface CanvasSessionContext {
|
|
2286
|
+
/**
|
|
2287
|
+
* Active session working directory, when known.
|
|
2288
|
+
*/
|
|
2289
|
+
workingDirectory?: string;
|
|
1906
2290
|
}
|
|
1907
2291
|
/**
|
|
1908
2292
|
* Canvas action invocation parameters sent to the provider.
|
|
@@ -1939,6 +2323,7 @@ export interface CanvasProviderInvokeActionRequest {
|
|
|
1939
2323
|
[k: string]: unknown | undefined;
|
|
1940
2324
|
};
|
|
1941
2325
|
host?: CanvasHostContext;
|
|
2326
|
+
session?: CanvasSessionContext;
|
|
1942
2327
|
}
|
|
1943
2328
|
/**
|
|
1944
2329
|
* Canvas open parameters sent to the provider.
|
|
@@ -1971,6 +2356,7 @@ export interface CanvasProviderOpenRequest {
|
|
|
1971
2356
|
[k: string]: unknown | undefined;
|
|
1972
2357
|
};
|
|
1973
2358
|
host?: CanvasHostContext;
|
|
2359
|
+
session?: CanvasSessionContext;
|
|
1974
2360
|
}
|
|
1975
2361
|
/**
|
|
1976
2362
|
* Canvas open result returned by the provider.
|
|
@@ -2266,7 +2652,7 @@ export interface ConnectRemoteSessionParams {
|
|
|
2266
2652
|
sessionId: string;
|
|
2267
2653
|
}
|
|
2268
2654
|
/**
|
|
2269
|
-
* The currently selected model
|
|
2655
|
+
* The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume.
|
|
2270
2656
|
*
|
|
2271
2657
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2272
2658
|
* via the `definition` "CurrentModel".
|
|
@@ -2281,6 +2667,46 @@ export interface CurrentModel {
|
|
|
2281
2667
|
* Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot.
|
|
2282
2668
|
*/
|
|
2283
2669
|
reasoningEffort?: string;
|
|
2670
|
+
contextTier?: ContextTier;
|
|
2671
|
+
}
|
|
2672
|
+
/**
|
|
2673
|
+
* Lightweight metadata for a currently initialized session tool
|
|
2674
|
+
*
|
|
2675
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2676
|
+
* via the `definition` "CurrentToolMetadata".
|
|
2677
|
+
*/
|
|
2678
|
+
/** @experimental */
|
|
2679
|
+
export interface CurrentToolMetadata {
|
|
2680
|
+
/**
|
|
2681
|
+
* Model-facing tool name
|
|
2682
|
+
*/
|
|
2683
|
+
name: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* Optional MCP/config namespaced tool name
|
|
2686
|
+
*/
|
|
2687
|
+
namespacedName?: string;
|
|
2688
|
+
/**
|
|
2689
|
+
* MCP server name for MCP-backed tools
|
|
2690
|
+
*/
|
|
2691
|
+
mcpServerName?: string;
|
|
2692
|
+
/**
|
|
2693
|
+
* Raw MCP tool name for MCP-backed tools
|
|
2694
|
+
*/
|
|
2695
|
+
mcpToolName?: string;
|
|
2696
|
+
/**
|
|
2697
|
+
* Tool description
|
|
2698
|
+
*/
|
|
2699
|
+
description: string;
|
|
2700
|
+
/**
|
|
2701
|
+
* JSON Schema for tool input
|
|
2702
|
+
*/
|
|
2703
|
+
input_schema?: {
|
|
2704
|
+
[k: string]: unknown | undefined;
|
|
2705
|
+
};
|
|
2706
|
+
/**
|
|
2707
|
+
* Whether the tool is loaded on demand via tool search
|
|
2708
|
+
*/
|
|
2709
|
+
deferLoading?: boolean;
|
|
2284
2710
|
}
|
|
2285
2711
|
/**
|
|
2286
2712
|
* Schema for the `DiscoveredMcpServer` type.
|
|
@@ -2450,6 +2876,29 @@ export interface Extension {
|
|
|
2450
2876
|
*/
|
|
2451
2877
|
pid?: number;
|
|
2452
2878
|
}
|
|
2879
|
+
/**
|
|
2880
|
+
* Slim input shape for extension_context attachments; identity fields are runtime-derived.
|
|
2881
|
+
*
|
|
2882
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2883
|
+
* via the `definition` "ExtensionContextPushInput".
|
|
2884
|
+
*/
|
|
2885
|
+
/** @experimental */
|
|
2886
|
+
export interface ExtensionContextPushInput {
|
|
2887
|
+
/**
|
|
2888
|
+
* Attachment type discriminator
|
|
2889
|
+
*/
|
|
2890
|
+
type: "extension_context";
|
|
2891
|
+
/**
|
|
2892
|
+
* Human-readable composer pill label
|
|
2893
|
+
*/
|
|
2894
|
+
title: string;
|
|
2895
|
+
/**
|
|
2896
|
+
* Caller-supplied JSON payload (required, may be null but not undefined)
|
|
2897
|
+
*/
|
|
2898
|
+
payload: {
|
|
2899
|
+
[k: string]: unknown | undefined;
|
|
2900
|
+
};
|
|
2901
|
+
}
|
|
2453
2902
|
/**
|
|
2454
2903
|
* Extensions discovered for the session, with their current status.
|
|
2455
2904
|
*
|
|
@@ -2986,13 +3435,13 @@ export interface InstalledPlugin {
|
|
|
2986
3435
|
source?: InstalledPluginSource;
|
|
2987
3436
|
}
|
|
2988
3437
|
/**
|
|
2989
|
-
* Schema for the `
|
|
3438
|
+
* Schema for the `InstalledPluginSourceGitHub` type.
|
|
2990
3439
|
*
|
|
2991
3440
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2992
|
-
* via the `definition` "
|
|
3441
|
+
* via the `definition` "InstalledPluginSourceGitHub".
|
|
2993
3442
|
*/
|
|
2994
3443
|
/** @experimental */
|
|
2995
|
-
export interface
|
|
3444
|
+
export interface InstalledPluginSourceGitHub {
|
|
2996
3445
|
/**
|
|
2997
3446
|
* Constant value. Always "github".
|
|
2998
3447
|
*/
|
|
@@ -3474,8 +3923,8 @@ export interface McpServerConfigStdio {
|
|
|
3474
3923
|
* Timeout in milliseconds for tool calls to this server.
|
|
3475
3924
|
*/
|
|
3476
3925
|
timeout?: number;
|
|
3477
|
-
oidc?:
|
|
3478
|
-
auth?:
|
|
3926
|
+
oidc?: McpServerAuthConfig;
|
|
3927
|
+
auth?: McpServerAuthConfig;
|
|
3479
3928
|
/**
|
|
3480
3929
|
* Executable command used to start the Stdio MCP server process.
|
|
3481
3930
|
*/
|
|
@@ -3495,6 +3944,19 @@ export interface McpServerConfigStdio {
|
|
|
3495
3944
|
[k: string]: string | undefined;
|
|
3496
3945
|
};
|
|
3497
3946
|
}
|
|
3947
|
+
/**
|
|
3948
|
+
* Authentication settings with optional redirect port configuration.
|
|
3949
|
+
*
|
|
3950
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3951
|
+
* via the `definition` "McpServerAuthConfigRedirectPort".
|
|
3952
|
+
*/
|
|
3953
|
+
export interface McpServerAuthConfigRedirectPort {
|
|
3954
|
+
/**
|
|
3955
|
+
* Fixed port for the OAuth redirect callback server.
|
|
3956
|
+
*/
|
|
3957
|
+
redirectPort?: number;
|
|
3958
|
+
[k: string]: unknown | undefined;
|
|
3959
|
+
}
|
|
3498
3960
|
/**
|
|
3499
3961
|
* Remote MCP server configuration accessed over HTTP or SSE.
|
|
3500
3962
|
*
|
|
@@ -3516,8 +3978,8 @@ export interface McpServerConfigHttp {
|
|
|
3516
3978
|
* Timeout in milliseconds for tool calls to this server.
|
|
3517
3979
|
*/
|
|
3518
3980
|
timeout?: number;
|
|
3519
|
-
oidc?:
|
|
3520
|
-
auth?:
|
|
3981
|
+
oidc?: McpServerAuthConfig;
|
|
3982
|
+
auth?: McpServerAuthConfig;
|
|
3521
3983
|
/**
|
|
3522
3984
|
* URL of the remote MCP server endpoint.
|
|
3523
3985
|
*/
|
|
@@ -3538,19 +4000,6 @@ export interface McpServerConfigHttp {
|
|
|
3538
4000
|
oauthPublicClient?: boolean;
|
|
3539
4001
|
oauthGrantType?: McpServerConfigHttpOauthGrantType;
|
|
3540
4002
|
}
|
|
3541
|
-
/**
|
|
3542
|
-
* Additional authentication configuration for this server.
|
|
3543
|
-
*
|
|
3544
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3545
|
-
* via the `definition` "McpServerConfigHttpAuth".
|
|
3546
|
-
*/
|
|
3547
|
-
export interface McpServerConfigHttpAuth {
|
|
3548
|
-
/**
|
|
3549
|
-
* Fixed port for the OAuth redirect callback server.
|
|
3550
|
-
*/
|
|
3551
|
-
redirectPort?: number;
|
|
3552
|
-
[k: string]: unknown | undefined;
|
|
3553
|
-
}
|
|
3554
4003
|
/**
|
|
3555
4004
|
* MCP server names to disable for new sessions.
|
|
3556
4005
|
*
|
|
@@ -4174,7 +4623,7 @@ export interface ModelBillingTokenPrices {
|
|
|
4174
4623
|
*/
|
|
4175
4624
|
batchSize?: number;
|
|
4176
4625
|
/**
|
|
4177
|
-
*
|
|
4626
|
+
* Prompt token budget (max_prompt_tokens) for the default tier. The total context window is this value plus the model's max_output_tokens.
|
|
4178
4627
|
*/
|
|
4179
4628
|
contextMax?: number;
|
|
4180
4629
|
longContext?: ModelBillingTokenPricesLongContext;
|
|
@@ -4199,7 +4648,7 @@ export interface ModelBillingTokenPricesLongContext {
|
|
|
4199
4648
|
*/
|
|
4200
4649
|
cachePrice?: number;
|
|
4201
4650
|
/**
|
|
4202
|
-
*
|
|
4651
|
+
* Prompt token budget (max_prompt_tokens) for the long context tier. The total context window is this value plus the model's max_output_tokens.
|
|
4203
4652
|
*/
|
|
4204
4653
|
contextMax?: number;
|
|
4205
4654
|
}
|
|
@@ -4286,6 +4735,19 @@ export interface ModelList {
|
|
|
4286
4735
|
*/
|
|
4287
4736
|
models: Model[];
|
|
4288
4737
|
}
|
|
4738
|
+
/**
|
|
4739
|
+
* Optional listing options.
|
|
4740
|
+
*
|
|
4741
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4742
|
+
* via the `definition` "ModelListRequest".
|
|
4743
|
+
*/
|
|
4744
|
+
/** @experimental */
|
|
4745
|
+
export interface ModelListRequest {
|
|
4746
|
+
/**
|
|
4747
|
+
* If true, bypasses the per-session model list cache and re-fetches from CAPI.
|
|
4748
|
+
*/
|
|
4749
|
+
skipCache?: boolean;
|
|
4750
|
+
}
|
|
4289
4751
|
/**
|
|
4290
4752
|
* Reasoning effort level to apply to the currently selected model.
|
|
4291
4753
|
*
|
|
@@ -4319,7 +4781,7 @@ export interface ModelsListRequest {
|
|
|
4319
4781
|
gitHubToken?: string;
|
|
4320
4782
|
}
|
|
4321
4783
|
/**
|
|
4322
|
-
* Target model identifier and optional reasoning effort, summary, and
|
|
4784
|
+
* Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.
|
|
4323
4785
|
*
|
|
4324
4786
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4325
4787
|
* via the `definition` "ModelSwitchToRequest".
|
|
@@ -4336,6 +4798,7 @@ export interface ModelSwitchToRequest {
|
|
|
4336
4798
|
reasoningEffort?: string;
|
|
4337
4799
|
reasoningSummary?: ReasoningSummary;
|
|
4338
4800
|
modelCapabilities?: ModelCapabilitiesOverride;
|
|
4801
|
+
contextTier?: ContextTier;
|
|
4339
4802
|
}
|
|
4340
4803
|
/**
|
|
4341
4804
|
* The model identifier active on the session after the switch.
|
|
@@ -5491,6 +5954,14 @@ export interface PermissionsFolderTrustAddTrustedResult {
|
|
|
5491
5954
|
*/
|
|
5492
5955
|
success: boolean;
|
|
5493
5956
|
}
|
|
5957
|
+
/**
|
|
5958
|
+
* No parameters.
|
|
5959
|
+
*
|
|
5960
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5961
|
+
* via the `definition` "PermissionsGetAllowAllRequest".
|
|
5962
|
+
*/
|
|
5963
|
+
export interface PermissionsGetAllowAllRequest {
|
|
5964
|
+
}
|
|
5494
5965
|
/**
|
|
5495
5966
|
* Indicates whether the operation succeeded.
|
|
5496
5967
|
*
|
|
@@ -5615,6 +6086,20 @@ export interface PermissionsResetSessionApprovalsResult {
|
|
|
5615
6086
|
*/
|
|
5616
6087
|
success: boolean;
|
|
5617
6088
|
}
|
|
6089
|
+
/**
|
|
6090
|
+
* Whether to enable full allow-all permissions for the session.
|
|
6091
|
+
*
|
|
6092
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6093
|
+
* via the `definition` "PermissionsSetAllowAllRequest".
|
|
6094
|
+
*/
|
|
6095
|
+
/** @experimental */
|
|
6096
|
+
export interface PermissionsSetAllowAllRequest {
|
|
6097
|
+
/**
|
|
6098
|
+
* Whether to enable full allow-all permissions
|
|
6099
|
+
*/
|
|
6100
|
+
enabled: boolean;
|
|
6101
|
+
source?: PermissionsSetAllowAllSource;
|
|
6102
|
+
}
|
|
5618
6103
|
/**
|
|
5619
6104
|
* Allow-all toggle for tool permission requests, with an optional telemetry source.
|
|
5620
6105
|
*
|
|
@@ -5792,11 +6277,197 @@ export interface Plugin {
|
|
|
5792
6277
|
* via the `definition` "PluginList".
|
|
5793
6278
|
*/
|
|
5794
6279
|
/** @experimental */
|
|
5795
|
-
export interface PluginList {
|
|
6280
|
+
export interface PluginList {
|
|
6281
|
+
/**
|
|
6282
|
+
* Installed plugins
|
|
6283
|
+
*/
|
|
6284
|
+
plugins: Plugin[];
|
|
6285
|
+
}
|
|
6286
|
+
/**
|
|
6287
|
+
* File attachment
|
|
6288
|
+
*
|
|
6289
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6290
|
+
* via the `definition` "PushAttachmentFile".
|
|
6291
|
+
*/
|
|
6292
|
+
/** @experimental */
|
|
6293
|
+
export interface PushAttachmentFile {
|
|
6294
|
+
/**
|
|
6295
|
+
* Attachment type discriminator
|
|
6296
|
+
*/
|
|
6297
|
+
type: "file";
|
|
6298
|
+
/**
|
|
6299
|
+
* Absolute file path
|
|
6300
|
+
*/
|
|
6301
|
+
path: string;
|
|
6302
|
+
/**
|
|
6303
|
+
* User-facing display name for the attachment
|
|
6304
|
+
*/
|
|
6305
|
+
displayName: string;
|
|
6306
|
+
lineRange?: PushAttachmentFileLineRange;
|
|
6307
|
+
}
|
|
6308
|
+
/**
|
|
6309
|
+
* Optional line range to scope the attachment to a specific section of the file
|
|
6310
|
+
*
|
|
6311
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6312
|
+
* via the `definition` "PushAttachmentFileLineRange".
|
|
6313
|
+
*/
|
|
6314
|
+
/** @experimental */
|
|
6315
|
+
export interface PushAttachmentFileLineRange {
|
|
6316
|
+
/**
|
|
6317
|
+
* Start line number (1-based)
|
|
6318
|
+
*/
|
|
6319
|
+
start: number;
|
|
6320
|
+
/**
|
|
6321
|
+
* End line number (1-based, inclusive)
|
|
6322
|
+
*/
|
|
6323
|
+
end: number;
|
|
6324
|
+
}
|
|
6325
|
+
/**
|
|
6326
|
+
* Directory attachment
|
|
6327
|
+
*
|
|
6328
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6329
|
+
* via the `definition` "PushAttachmentDirectory".
|
|
6330
|
+
*/
|
|
6331
|
+
/** @experimental */
|
|
6332
|
+
export interface PushAttachmentDirectory {
|
|
6333
|
+
/**
|
|
6334
|
+
* Attachment type discriminator
|
|
6335
|
+
*/
|
|
6336
|
+
type: "directory";
|
|
6337
|
+
/**
|
|
6338
|
+
* Absolute directory path
|
|
6339
|
+
*/
|
|
6340
|
+
path: string;
|
|
6341
|
+
/**
|
|
6342
|
+
* User-facing display name for the attachment
|
|
6343
|
+
*/
|
|
6344
|
+
displayName: string;
|
|
6345
|
+
}
|
|
6346
|
+
/**
|
|
6347
|
+
* Code selection attachment from an editor
|
|
6348
|
+
*
|
|
6349
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6350
|
+
* via the `definition` "PushAttachmentSelection".
|
|
6351
|
+
*/
|
|
6352
|
+
/** @experimental */
|
|
6353
|
+
export interface PushAttachmentSelection {
|
|
6354
|
+
/**
|
|
6355
|
+
* Attachment type discriminator
|
|
6356
|
+
*/
|
|
6357
|
+
type: "selection";
|
|
6358
|
+
/**
|
|
6359
|
+
* Absolute path to the file containing the selection
|
|
6360
|
+
*/
|
|
6361
|
+
filePath: string;
|
|
6362
|
+
/**
|
|
6363
|
+
* User-facing display name for the selection
|
|
6364
|
+
*/
|
|
6365
|
+
displayName: string;
|
|
6366
|
+
/**
|
|
6367
|
+
* The selected text content
|
|
6368
|
+
*/
|
|
6369
|
+
text: string;
|
|
6370
|
+
selection: PushAttachmentSelectionDetails;
|
|
6371
|
+
}
|
|
6372
|
+
/**
|
|
6373
|
+
* Position range of the selection within the file
|
|
6374
|
+
*
|
|
6375
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6376
|
+
* via the `definition` "PushAttachmentSelectionDetails".
|
|
6377
|
+
*/
|
|
6378
|
+
/** @experimental */
|
|
6379
|
+
export interface PushAttachmentSelectionDetails {
|
|
6380
|
+
start: PushAttachmentSelectionDetailsStart;
|
|
6381
|
+
end: PushAttachmentSelectionDetailsEnd;
|
|
6382
|
+
}
|
|
6383
|
+
/**
|
|
6384
|
+
* Start position of the selection
|
|
6385
|
+
*
|
|
6386
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6387
|
+
* via the `definition` "PushAttachmentSelectionDetailsStart".
|
|
6388
|
+
*/
|
|
6389
|
+
/** @experimental */
|
|
6390
|
+
export interface PushAttachmentSelectionDetailsStart {
|
|
6391
|
+
/**
|
|
6392
|
+
* Start line number (0-based)
|
|
6393
|
+
*/
|
|
6394
|
+
line: number;
|
|
6395
|
+
/**
|
|
6396
|
+
* Start character offset within the line (0-based)
|
|
6397
|
+
*/
|
|
6398
|
+
character: number;
|
|
6399
|
+
}
|
|
6400
|
+
/**
|
|
6401
|
+
* End position of the selection
|
|
6402
|
+
*
|
|
6403
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6404
|
+
* via the `definition` "PushAttachmentSelectionDetailsEnd".
|
|
6405
|
+
*/
|
|
6406
|
+
/** @experimental */
|
|
6407
|
+
export interface PushAttachmentSelectionDetailsEnd {
|
|
6408
|
+
/**
|
|
6409
|
+
* End line number (0-based)
|
|
6410
|
+
*/
|
|
6411
|
+
line: number;
|
|
6412
|
+
/**
|
|
6413
|
+
* End character offset within the line (0-based)
|
|
6414
|
+
*/
|
|
6415
|
+
character: number;
|
|
6416
|
+
}
|
|
6417
|
+
/**
|
|
6418
|
+
* GitHub issue, pull request, or discussion reference
|
|
6419
|
+
*
|
|
6420
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6421
|
+
* via the `definition` "PushAttachmentGitHubReference".
|
|
6422
|
+
*/
|
|
6423
|
+
/** @experimental */
|
|
6424
|
+
export interface PushAttachmentGitHubReference {
|
|
6425
|
+
/**
|
|
6426
|
+
* Attachment type discriminator
|
|
6427
|
+
*/
|
|
6428
|
+
type: "github_reference";
|
|
6429
|
+
/**
|
|
6430
|
+
* Issue, pull request, or discussion number
|
|
6431
|
+
*/
|
|
6432
|
+
number: number;
|
|
6433
|
+
/**
|
|
6434
|
+
* Title of the referenced item
|
|
6435
|
+
*/
|
|
6436
|
+
title: string;
|
|
6437
|
+
referenceType: PushAttachmentGitHubReferenceType;
|
|
6438
|
+
/**
|
|
6439
|
+
* Current state of the referenced item (e.g., open, closed, merged)
|
|
6440
|
+
*/
|
|
6441
|
+
state: string;
|
|
6442
|
+
/**
|
|
6443
|
+
* URL to the referenced item on GitHub
|
|
6444
|
+
*/
|
|
6445
|
+
url: string;
|
|
6446
|
+
}
|
|
6447
|
+
/**
|
|
6448
|
+
* Blob attachment with inline base64-encoded data
|
|
6449
|
+
*
|
|
6450
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6451
|
+
* via the `definition` "PushAttachmentBlob".
|
|
6452
|
+
*/
|
|
6453
|
+
/** @experimental */
|
|
6454
|
+
export interface PushAttachmentBlob {
|
|
5796
6455
|
/**
|
|
5797
|
-
*
|
|
6456
|
+
* Attachment type discriminator
|
|
5798
6457
|
*/
|
|
5799
|
-
|
|
6458
|
+
type: "blob";
|
|
6459
|
+
/**
|
|
6460
|
+
* Base64-encoded content
|
|
6461
|
+
*/
|
|
6462
|
+
data: string;
|
|
6463
|
+
/**
|
|
6464
|
+
* MIME type of the inline data
|
|
6465
|
+
*/
|
|
6466
|
+
mimeType: string;
|
|
6467
|
+
/**
|
|
6468
|
+
* User-facing display name for the attachment
|
|
6469
|
+
*/
|
|
6470
|
+
displayName?: string;
|
|
5800
6471
|
}
|
|
5801
6472
|
/**
|
|
5802
6473
|
* Schema for the `QueuePendingItems` type.
|
|
@@ -6038,190 +6709,21 @@ export interface SecretsAddFilterValuesResult {
|
|
|
6038
6709
|
ok: true;
|
|
6039
6710
|
}
|
|
6040
6711
|
/**
|
|
6041
|
-
*
|
|
6042
|
-
*
|
|
6043
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6044
|
-
* via the `definition` "SendAttachmentFile".
|
|
6045
|
-
*/
|
|
6046
|
-
/** @experimental */
|
|
6047
|
-
export interface SendAttachmentFile {
|
|
6048
|
-
/**
|
|
6049
|
-
* Attachment type discriminator
|
|
6050
|
-
*/
|
|
6051
|
-
type: "file";
|
|
6052
|
-
/**
|
|
6053
|
-
* Absolute file path
|
|
6054
|
-
*/
|
|
6055
|
-
path: string;
|
|
6056
|
-
/**
|
|
6057
|
-
* User-facing display name for the attachment
|
|
6058
|
-
*/
|
|
6059
|
-
displayName: string;
|
|
6060
|
-
lineRange?: SendAttachmentFileLineRange;
|
|
6061
|
-
}
|
|
6062
|
-
/**
|
|
6063
|
-
* Optional line range to scope the attachment to a specific section of the file
|
|
6064
|
-
*
|
|
6065
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6066
|
-
* via the `definition` "SendAttachmentFileLineRange".
|
|
6067
|
-
*/
|
|
6068
|
-
/** @experimental */
|
|
6069
|
-
export interface SendAttachmentFileLineRange {
|
|
6070
|
-
/**
|
|
6071
|
-
* Start line number (1-based)
|
|
6072
|
-
*/
|
|
6073
|
-
start: number;
|
|
6074
|
-
/**
|
|
6075
|
-
* End line number (1-based, inclusive)
|
|
6076
|
-
*/
|
|
6077
|
-
end: number;
|
|
6078
|
-
}
|
|
6079
|
-
/**
|
|
6080
|
-
* Directory attachment
|
|
6081
|
-
*
|
|
6082
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6083
|
-
* via the `definition` "SendAttachmentDirectory".
|
|
6084
|
-
*/
|
|
6085
|
-
/** @experimental */
|
|
6086
|
-
export interface SendAttachmentDirectory {
|
|
6087
|
-
/**
|
|
6088
|
-
* Attachment type discriminator
|
|
6089
|
-
*/
|
|
6090
|
-
type: "directory";
|
|
6091
|
-
/**
|
|
6092
|
-
* Absolute directory path
|
|
6093
|
-
*/
|
|
6094
|
-
path: string;
|
|
6095
|
-
/**
|
|
6096
|
-
* User-facing display name for the attachment
|
|
6097
|
-
*/
|
|
6098
|
-
displayName: string;
|
|
6099
|
-
}
|
|
6100
|
-
/**
|
|
6101
|
-
* Code selection attachment from an editor
|
|
6102
|
-
*
|
|
6103
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6104
|
-
* via the `definition` "SendAttachmentSelection".
|
|
6105
|
-
*/
|
|
6106
|
-
/** @experimental */
|
|
6107
|
-
export interface SendAttachmentSelection {
|
|
6108
|
-
/**
|
|
6109
|
-
* Attachment type discriminator
|
|
6110
|
-
*/
|
|
6111
|
-
type: "selection";
|
|
6112
|
-
/**
|
|
6113
|
-
* Absolute path to the file containing the selection
|
|
6114
|
-
*/
|
|
6115
|
-
filePath: string;
|
|
6116
|
-
/**
|
|
6117
|
-
* User-facing display name for the selection
|
|
6118
|
-
*/
|
|
6119
|
-
displayName: string;
|
|
6120
|
-
/**
|
|
6121
|
-
* The selected text content
|
|
6122
|
-
*/
|
|
6123
|
-
text: string;
|
|
6124
|
-
selection: SendAttachmentSelectionDetails;
|
|
6125
|
-
}
|
|
6126
|
-
/**
|
|
6127
|
-
* Position range of the selection within the file
|
|
6128
|
-
*
|
|
6129
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6130
|
-
* via the `definition` "SendAttachmentSelectionDetails".
|
|
6131
|
-
*/
|
|
6132
|
-
/** @experimental */
|
|
6133
|
-
export interface SendAttachmentSelectionDetails {
|
|
6134
|
-
start: SendAttachmentSelectionDetailsStart;
|
|
6135
|
-
end: SendAttachmentSelectionDetailsEnd;
|
|
6136
|
-
}
|
|
6137
|
-
/**
|
|
6138
|
-
* Start position of the selection
|
|
6139
|
-
*
|
|
6140
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6141
|
-
* via the `definition` "SendAttachmentSelectionDetailsStart".
|
|
6142
|
-
*/
|
|
6143
|
-
/** @experimental */
|
|
6144
|
-
export interface SendAttachmentSelectionDetailsStart {
|
|
6145
|
-
/**
|
|
6146
|
-
* Start line number (0-based)
|
|
6147
|
-
*/
|
|
6148
|
-
line: number;
|
|
6149
|
-
/**
|
|
6150
|
-
* Start character offset within the line (0-based)
|
|
6151
|
-
*/
|
|
6152
|
-
character: number;
|
|
6153
|
-
}
|
|
6154
|
-
/**
|
|
6155
|
-
* End position of the selection
|
|
6156
|
-
*
|
|
6157
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6158
|
-
* via the `definition` "SendAttachmentSelectionDetailsEnd".
|
|
6159
|
-
*/
|
|
6160
|
-
/** @experimental */
|
|
6161
|
-
export interface SendAttachmentSelectionDetailsEnd {
|
|
6162
|
-
/**
|
|
6163
|
-
* End line number (0-based)
|
|
6164
|
-
*/
|
|
6165
|
-
line: number;
|
|
6166
|
-
/**
|
|
6167
|
-
* End character offset within the line (0-based)
|
|
6168
|
-
*/
|
|
6169
|
-
character: number;
|
|
6170
|
-
}
|
|
6171
|
-
/**
|
|
6172
|
-
* GitHub issue, pull request, or discussion reference
|
|
6173
|
-
*
|
|
6174
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6175
|
-
* via the `definition` "SendAttachmentGithubReference".
|
|
6176
|
-
*/
|
|
6177
|
-
/** @experimental */
|
|
6178
|
-
export interface SendAttachmentGithubReference {
|
|
6179
|
-
/**
|
|
6180
|
-
* Attachment type discriminator
|
|
6181
|
-
*/
|
|
6182
|
-
type: "github_reference";
|
|
6183
|
-
/**
|
|
6184
|
-
* Issue, pull request, or discussion number
|
|
6185
|
-
*/
|
|
6186
|
-
number: number;
|
|
6187
|
-
/**
|
|
6188
|
-
* Title of the referenced item
|
|
6189
|
-
*/
|
|
6190
|
-
title: string;
|
|
6191
|
-
referenceType: SendAttachmentGithubReferenceType;
|
|
6192
|
-
/**
|
|
6193
|
-
* Current state of the referenced item (e.g., open, closed, merged)
|
|
6194
|
-
*/
|
|
6195
|
-
state: string;
|
|
6196
|
-
/**
|
|
6197
|
-
* URL to the referenced item on GitHub
|
|
6198
|
-
*/
|
|
6199
|
-
url: string;
|
|
6200
|
-
}
|
|
6201
|
-
/**
|
|
6202
|
-
* Blob attachment with inline base64-encoded data
|
|
6712
|
+
* Parameters for session.extensions.sendAttachmentsToMessage.
|
|
6203
6713
|
*
|
|
6204
6714
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6205
|
-
* via the `definition` "
|
|
6715
|
+
* via the `definition` "SendAttachmentsToMessageParams".
|
|
6206
6716
|
*/
|
|
6207
6717
|
/** @experimental */
|
|
6208
|
-
export interface
|
|
6209
|
-
/**
|
|
6210
|
-
* Attachment type discriminator
|
|
6211
|
-
*/
|
|
6212
|
-
type: "blob";
|
|
6213
|
-
/**
|
|
6214
|
-
* Base64-encoded content
|
|
6215
|
-
*/
|
|
6216
|
-
data: string;
|
|
6718
|
+
export interface SendAttachmentsToMessageParams {
|
|
6217
6719
|
/**
|
|
6218
|
-
*
|
|
6720
|
+
* Optional canvas instance binding the push for provenance. When supplied, the runtime resolves the canvas, verifies it is owned by the calling extension, and stamps canvasId/instanceId onto each extension_context entry. When omitted, no resolution runs and those fields stay unset on the attachment.
|
|
6219
6721
|
*/
|
|
6220
|
-
|
|
6722
|
+
instanceId?: string;
|
|
6221
6723
|
/**
|
|
6222
|
-
*
|
|
6724
|
+
* Attachments to push into the next user-message turn. extension_context entries take the slim shape; standard variants take their full AttachmentSchema shape.
|
|
6223
6725
|
*/
|
|
6224
|
-
|
|
6726
|
+
attachments: PushAttachment[];
|
|
6225
6727
|
}
|
|
6226
6728
|
/**
|
|
6227
6729
|
* Parameters for sending a user message to the session
|
|
@@ -6242,7 +6744,7 @@ export interface SendRequest {
|
|
|
6242
6744
|
/**
|
|
6243
6745
|
* Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message
|
|
6244
6746
|
*/
|
|
6245
|
-
attachments?:
|
|
6747
|
+
attachments?: Attachment[];
|
|
6246
6748
|
mode?: SendMode;
|
|
6247
6749
|
/**
|
|
6248
6750
|
* If true, adds the message to the front of the queue instead of the end
|
|
@@ -6446,10 +6948,18 @@ export interface SessionMetadata {
|
|
|
6446
6948
|
* Optional human-friendly name set via /rename
|
|
6447
6949
|
*/
|
|
6448
6950
|
name?: string;
|
|
6951
|
+
/**
|
|
6952
|
+
* Runtime client name that created/last resumed this session
|
|
6953
|
+
*/
|
|
6954
|
+
clientName?: string;
|
|
6449
6955
|
/**
|
|
6450
6956
|
* True for remote (GitHub) sessions; false for local
|
|
6451
6957
|
*/
|
|
6452
6958
|
isRemote: boolean;
|
|
6959
|
+
/**
|
|
6960
|
+
* True for detached maintenance sessions that should be hidden from normal resume lists.
|
|
6961
|
+
*/
|
|
6962
|
+
isDetached?: boolean;
|
|
6453
6963
|
context?: SessionContext;
|
|
6454
6964
|
/**
|
|
6455
6965
|
* GitHub task ID, when this local session is bound to one. Only present for local sessions exported to remote control.
|
|
@@ -6917,13 +7427,13 @@ export interface SessionInstalledPlugin {
|
|
|
6917
7427
|
source?: SessionInstalledPluginSource;
|
|
6918
7428
|
}
|
|
6919
7429
|
/**
|
|
6920
|
-
* Schema for the `
|
|
7430
|
+
* Schema for the `SessionInstalledPluginSourceGitHub` type.
|
|
6921
7431
|
*
|
|
6922
7432
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6923
|
-
* via the `definition` "
|
|
7433
|
+
* via the `definition` "SessionInstalledPluginSourceGitHub".
|
|
6924
7434
|
*/
|
|
6925
7435
|
/** @experimental */
|
|
6926
|
-
export interface
|
|
7436
|
+
export interface SessionInstalledPluginSourceGitHub {
|
|
6927
7437
|
/**
|
|
6928
7438
|
* Constant value. Always "github".
|
|
6929
7439
|
*/
|
|
@@ -7053,6 +7563,10 @@ export interface SessionMetadataSnapshot {
|
|
|
7053
7563
|
* User-provided name supplied at session construction (via `--name`), if any. Immutable after construction.
|
|
7054
7564
|
*/
|
|
7055
7565
|
initialName?: string;
|
|
7566
|
+
/**
|
|
7567
|
+
* Runtime client name associated with the session (telemetry identifier).
|
|
7568
|
+
*/
|
|
7569
|
+
clientName?: string;
|
|
7056
7570
|
remoteMetadata?: MetadataSnapshotRemoteMetadata;
|
|
7057
7571
|
/**
|
|
7058
7572
|
* Short human-readable summary of the session, if known. Omitted when no summary has been generated.
|
|
@@ -7072,6 +7586,25 @@ export interface SessionMetadataSnapshot {
|
|
|
7072
7586
|
*/
|
|
7073
7587
|
workspace?: WorkspaceSummary | null;
|
|
7074
7588
|
}
|
|
7589
|
+
/**
|
|
7590
|
+
* The list of models available to this session.
|
|
7591
|
+
*
|
|
7592
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7593
|
+
* via the `definition` "SessionModelList".
|
|
7594
|
+
*/
|
|
7595
|
+
/** @experimental */
|
|
7596
|
+
export interface SessionModelList {
|
|
7597
|
+
/**
|
|
7598
|
+
* Available models, ordered with the most preferred default first.
|
|
7599
|
+
*/
|
|
7600
|
+
list: unknown[];
|
|
7601
|
+
/**
|
|
7602
|
+
* Per-quota snapshots returned alongside the model list, keyed by quota type.
|
|
7603
|
+
*/
|
|
7604
|
+
quotaSnapshots?: {
|
|
7605
|
+
[k: string]: unknown | undefined;
|
|
7606
|
+
};
|
|
7607
|
+
}
|
|
7075
7608
|
/**
|
|
7076
7609
|
* Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag.
|
|
7077
7610
|
*
|
|
@@ -7379,7 +7912,7 @@ export interface SessionSizes {
|
|
|
7379
7912
|
};
|
|
7380
7913
|
}
|
|
7381
7914
|
/**
|
|
7382
|
-
* Optional metadata-load limit and
|
|
7915
|
+
* Optional metadata-load limit and filters applied to the returned sessions.
|
|
7383
7916
|
*
|
|
7384
7917
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7385
7918
|
* via the `definition` "SessionsListRequest".
|
|
@@ -7391,6 +7924,10 @@ export interface SessionsListRequest {
|
|
|
7391
7924
|
*/
|
|
7392
7925
|
metadataLimit?: number;
|
|
7393
7926
|
filter?: SessionListFilter;
|
|
7927
|
+
/**
|
|
7928
|
+
* When true, include detached maintenance sessions. Defaults to false for user-facing session lists.
|
|
7929
|
+
*/
|
|
7930
|
+
includeDetached?: boolean;
|
|
7394
7931
|
}
|
|
7395
7932
|
/**
|
|
7396
7933
|
* Active session ID whose deferred repo-level hooks should be loaded.
|
|
@@ -7580,6 +8117,7 @@ export interface SessionUpdateOptionsParams {
|
|
|
7580
8117
|
* Denylist of tool names for this session.
|
|
7581
8118
|
*/
|
|
7582
8119
|
excludedTools?: string[];
|
|
8120
|
+
toolFilterPrecedence?: OptionsUpdateToolFilterPrecedence;
|
|
7583
8121
|
/**
|
|
7584
8122
|
* Whether shell-script safety heuristics are enabled.
|
|
7585
8123
|
*/
|
|
@@ -7625,6 +8163,10 @@ export interface SessionUpdateOptionsParams {
|
|
|
7625
8163
|
* Whether to default custom agents to local-only execution.
|
|
7626
8164
|
*/
|
|
7627
8165
|
customAgentsLocalOnly?: boolean;
|
|
8166
|
+
/**
|
|
8167
|
+
* When true, the selected custom agent's prompt is not injected into the user message (skill context is still injected). Used by automation triggers where the agent prompt is already in the problem statement.
|
|
8168
|
+
*/
|
|
8169
|
+
suppressCustomAgentPrompt?: boolean;
|
|
7628
8170
|
/**
|
|
7629
8171
|
* Whether to skip loading custom instruction sources.
|
|
7630
8172
|
*/
|
|
@@ -7683,6 +8225,30 @@ export interface SessionUpdateOptionsParams {
|
|
|
7683
8225
|
* Whether to expose the `manage_schedule` tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users).
|
|
7684
8226
|
*/
|
|
7685
8227
|
manageScheduleEnabled?: boolean;
|
|
8228
|
+
/**
|
|
8229
|
+
* Whether to skip embedding retrieval pipeline initialization and execution.
|
|
8230
|
+
*/
|
|
8231
|
+
skipEmbeddingRetrieval?: boolean;
|
|
8232
|
+
/**
|
|
8233
|
+
* Organization-level custom instructions to inject into the system prompt.
|
|
8234
|
+
*/
|
|
8235
|
+
organizationCustomInstructions?: string;
|
|
8236
|
+
/**
|
|
8237
|
+
* Whether to enable loading of `.github/hooks/` filesystem hooks. Separate from the SDK callback hook mechanism.
|
|
8238
|
+
*/
|
|
8239
|
+
enableFileHooks?: boolean;
|
|
8240
|
+
/**
|
|
8241
|
+
* Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt).
|
|
8242
|
+
*/
|
|
8243
|
+
enableHostGitOperations?: boolean;
|
|
8244
|
+
/**
|
|
8245
|
+
* Whether to enable cross-session store writes and reads.
|
|
8246
|
+
*/
|
|
8247
|
+
enableSessionStore?: boolean;
|
|
8248
|
+
/**
|
|
8249
|
+
* Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset.
|
|
8250
|
+
*/
|
|
8251
|
+
enableSkills?: boolean;
|
|
7686
8252
|
}
|
|
7687
8253
|
/**
|
|
7688
8254
|
* Indicates whether the session options patch was applied successfully.
|
|
@@ -8532,6 +9098,19 @@ export interface ToolList {
|
|
|
8532
9098
|
*/
|
|
8533
9099
|
tools: Tool[];
|
|
8534
9100
|
}
|
|
9101
|
+
/**
|
|
9102
|
+
* Current lightweight tool metadata snapshot for the session.
|
|
9103
|
+
*
|
|
9104
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9105
|
+
* via the `definition` "ToolsGetCurrentMetadataResult".
|
|
9106
|
+
*/
|
|
9107
|
+
/** @experimental */
|
|
9108
|
+
export interface ToolsGetCurrentMetadataResult {
|
|
9109
|
+
/**
|
|
9110
|
+
* Current tool metadata, or null when tools have not been initialized yet
|
|
9111
|
+
*/
|
|
9112
|
+
tools: CurrentToolMetadata[] | null;
|
|
9113
|
+
}
|
|
8535
9114
|
/**
|
|
8536
9115
|
* Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation.
|
|
8537
9116
|
*
|
|
@@ -9366,6 +9945,7 @@ export interface WorkspacesGetWorkspaceResult {
|
|
|
9366
9945
|
host_type?: WorkspacesWorkspaceDetailsHostType;
|
|
9367
9946
|
branch?: string;
|
|
9368
9947
|
name?: string;
|
|
9948
|
+
client_name?: string;
|
|
9369
9949
|
user_named?: boolean;
|
|
9370
9950
|
summary_count?: number;
|
|
9371
9951
|
created_at?: string;
|
|
@@ -9609,6 +10189,10 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
9609
10189
|
* @param params MCP server names to disable for new sessions.
|
|
9610
10190
|
*/
|
|
9611
10191
|
disable: (params: McpConfigDisableRequest) => Promise<void>;
|
|
10192
|
+
/**
|
|
10193
|
+
* Drops this runtime process's in-memory MCP server-definition cache so the next MCP config read observes disk.
|
|
10194
|
+
*/
|
|
10195
|
+
reload: () => Promise<void>;
|
|
9612
10196
|
};
|
|
9613
10197
|
/**
|
|
9614
10198
|
* Discovers MCP servers from user, workspace, plugin, and builtin sources.
|
|
@@ -9637,6 +10221,20 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
9637
10221
|
*/
|
|
9638
10222
|
discover: (params: SkillsDiscoverRequest) => Promise<ServerSkillList>;
|
|
9639
10223
|
};
|
|
10224
|
+
user: {
|
|
10225
|
+
settings: {
|
|
10226
|
+
/**
|
|
10227
|
+
* Drops this runtime process's in-memory user settings cache so the next settings read observes disk.
|
|
10228
|
+
*/
|
|
10229
|
+
reload: () => Promise<void>;
|
|
10230
|
+
};
|
|
10231
|
+
};
|
|
10232
|
+
runtime: {
|
|
10233
|
+
/**
|
|
10234
|
+
* Gracefully shuts down an SDK-owned runtime. The response is sent only after cleanup completes; callers may then terminate the owned runtime process.
|
|
10235
|
+
*/
|
|
10236
|
+
shutdown: () => Promise<void>;
|
|
10237
|
+
};
|
|
9640
10238
|
sessionFs: {
|
|
9641
10239
|
/**
|
|
9642
10240
|
* Registers an SDK client as the session filesystem provider.
|
|
@@ -9668,7 +10266,7 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
9668
10266
|
/**
|
|
9669
10267
|
* Lists persisted sessions, optionally filtered by working-directory context.
|
|
9670
10268
|
*
|
|
9671
|
-
* @param params Optional metadata-load limit and
|
|
10269
|
+
* @param params Optional metadata-load limit and filters applied to the returned sessions.
|
|
9672
10270
|
*
|
|
9673
10271
|
* @returns Persisted sessions matching the filter, ordered most-recently-modified first.
|
|
9674
10272
|
*/
|
|
@@ -9800,6 +10398,17 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
9800
10398
|
*/
|
|
9801
10399
|
setAdditionalPlugins: (params: SessionsSetAdditionalPluginsRequest) => Promise<SessionsSetAdditionalPluginsResult>;
|
|
9802
10400
|
};
|
|
10401
|
+
/** @experimental */
|
|
10402
|
+
agentRegistry: {
|
|
10403
|
+
/**
|
|
10404
|
+
* Spawns a managed-server child with the supplied configuration and returns a discriminated-union result. The caller (typically the CLI controller) is responsible for attaching to the spawned child and sending any follow-up prompt. When the controller-local spawn gate is closed the server returns JSON-RPC MethodNotFound.
|
|
10405
|
+
*
|
|
10406
|
+
* @param params Inputs to spawn a managed-server child via the controller's spawn delegate.
|
|
10407
|
+
*
|
|
10408
|
+
* @returns Outcome of an agentRegistry.spawn call.
|
|
10409
|
+
*/
|
|
10410
|
+
spawn: (params: AgentRegistrySpawnRequest) => Promise<AgentRegistrySpawnResult>;
|
|
10411
|
+
};
|
|
9803
10412
|
};
|
|
9804
10413
|
/** Create typed session-scoped RPC methods. */
|
|
9805
10414
|
export declare function createSessionRpc(connection: MessageConnection, sessionId: string): {
|
|
@@ -9882,27 +10491,30 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
9882
10491
|
* @param params Canvas close parameters.
|
|
9883
10492
|
*/
|
|
9884
10493
|
close: (params: CanvasCloseRequest) => Promise<void>;
|
|
9885
|
-
/**
|
|
9886
|
-
|
|
9887
|
-
|
|
9888
|
-
|
|
9889
|
-
|
|
9890
|
-
|
|
9891
|
-
|
|
9892
|
-
|
|
10494
|
+
/** @experimental */
|
|
10495
|
+
action: {
|
|
10496
|
+
/**
|
|
10497
|
+
* Invokes an action on an open canvas instance.
|
|
10498
|
+
*
|
|
10499
|
+
* @param params Canvas action invocation parameters.
|
|
10500
|
+
*
|
|
10501
|
+
* @returns Canvas action invocation result.
|
|
10502
|
+
*/
|
|
10503
|
+
invoke: (params: CanvasActionInvokeRequest) => Promise<CanvasActionInvokeResult>;
|
|
10504
|
+
};
|
|
9893
10505
|
};
|
|
9894
10506
|
/** @experimental */
|
|
9895
10507
|
model: {
|
|
9896
10508
|
/**
|
|
9897
10509
|
* Gets the currently selected model for the session.
|
|
9898
10510
|
*
|
|
9899
|
-
* @returns The currently selected model
|
|
10511
|
+
* @returns The currently selected model, reasoning effort, and context tier for the session. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume.
|
|
9900
10512
|
*/
|
|
9901
10513
|
getCurrent: () => Promise<CurrentModel>;
|
|
9902
10514
|
/**
|
|
9903
10515
|
* Switches the session to a model and optional reasoning configuration.
|
|
9904
10516
|
*
|
|
9905
|
-
* @param params Target model identifier and optional reasoning effort, summary, and
|
|
10517
|
+
* @param params Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.
|
|
9906
10518
|
*
|
|
9907
10519
|
* @returns The model identifier active on the session after the switch.
|
|
9908
10520
|
*/
|
|
@@ -9915,6 +10527,14 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
9915
10527
|
* @returns Update the session's reasoning effort without changing the selected model. Use `switchTo` instead when you also need to change the model. The runtime stores the effort on the session and applies it to subsequent turns.
|
|
9916
10528
|
*/
|
|
9917
10529
|
setReasoningEffort: (params: ModelSetReasoningEffortRequest) => Promise<ModelSetReasoningEffortResult>;
|
|
10530
|
+
/**
|
|
10531
|
+
* Lists models available to this session using its own auth and integration context. Connected hosts (CLI TUI, GitHub App) should call this through the session client so remote sessions return the remote CLI's available models rather than the caller's.
|
|
10532
|
+
*
|
|
10533
|
+
* @param params Optional listing options.
|
|
10534
|
+
*
|
|
10535
|
+
* @returns The list of models available to this session.
|
|
10536
|
+
*/
|
|
10537
|
+
list: (params?: ModelListRequest) => Promise<SessionModelList>;
|
|
9918
10538
|
};
|
|
9919
10539
|
/** @experimental */
|
|
9920
10540
|
mode: {
|
|
@@ -10369,6 +10989,12 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
10369
10989
|
* Reloads extension definitions and processes for the session.
|
|
10370
10990
|
*/
|
|
10371
10991
|
reload: () => Promise<void>;
|
|
10992
|
+
/**
|
|
10993
|
+
* Push attachments into the next user-message turn from an extension. The host should surface them as composer pills and forward them via the next session.send call. Callable only by extension-owned connections.
|
|
10994
|
+
*
|
|
10995
|
+
* @param params Parameters for session.extensions.sendAttachmentsToMessage.
|
|
10996
|
+
*/
|
|
10997
|
+
sendAttachmentsToMessage: (params: SendAttachmentsToMessageParams) => Promise<void>;
|
|
10372
10998
|
};
|
|
10373
10999
|
/** @experimental */
|
|
10374
11000
|
tools: {
|
|
@@ -10386,6 +11012,12 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
10386
11012
|
* @returns Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation.
|
|
10387
11013
|
*/
|
|
10388
11014
|
initializeAndValidate: () => Promise<ToolsInitializeAndValidateResult>;
|
|
11015
|
+
/**
|
|
11016
|
+
* Returns lightweight metadata for the session's currently initialized tools.
|
|
11017
|
+
*
|
|
11018
|
+
* @returns Current lightweight tool metadata snapshot for the session.
|
|
11019
|
+
*/
|
|
11020
|
+
getCurrentMetadata: () => Promise<ToolsGetCurrentMetadataResult>;
|
|
10389
11021
|
};
|
|
10390
11022
|
/** @experimental */
|
|
10391
11023
|
commands: {
|
|
@@ -10544,6 +11176,20 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
10544
11176
|
* @returns Indicates whether the operation succeeded.
|
|
10545
11177
|
*/
|
|
10546
11178
|
setApproveAll: (params: PermissionsSetApproveAllRequest) => Promise<PermissionsSetApproveAllResult>;
|
|
11179
|
+
/**
|
|
11180
|
+
* Enables or disables full allow-all permissions (tools, paths, and URLs) for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. Unlike `setApproveAll`, this swaps in the unrestricted path and URL managers and emits `session.permissions_changed` on transition. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire.
|
|
11181
|
+
*
|
|
11182
|
+
* @param params Whether to enable full allow-all permissions for the session.
|
|
11183
|
+
*
|
|
11184
|
+
* @returns Indicates whether the operation succeeded and reports the post-mutation state.
|
|
11185
|
+
*/
|
|
11186
|
+
setAllowAll: (params: PermissionsSetAllowAllRequest) => Promise<AllowAllPermissionSetResult>;
|
|
11187
|
+
/**
|
|
11188
|
+
* Returns whether full allow-all permissions are currently active for the session.
|
|
11189
|
+
*
|
|
11190
|
+
* @returns Current full allow-all permission state.
|
|
11191
|
+
*/
|
|
11192
|
+
getAllowAll: () => Promise<AllowAllPermissionState>;
|
|
10547
11193
|
/**
|
|
10548
11194
|
* Adds or removes session-scoped or location-scoped permission rules.
|
|
10549
11195
|
*
|
|
@@ -11012,7 +11658,7 @@ export interface CanvasHandler {
|
|
|
11012
11658
|
*
|
|
11013
11659
|
* @returns Provider-supplied action result.
|
|
11014
11660
|
*/
|
|
11015
|
-
|
|
11661
|
+
invoke(params: CanvasProviderInvokeActionRequest): Promise<CanvasActionInvokeResult>;
|
|
11016
11662
|
}
|
|
11017
11663
|
/** All client session API handler groups. */
|
|
11018
11664
|
export interface ClientSessionApiHandlers {
|