@github/copilot-sdk 1.0.9 → 1.0.11-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/dist/cjs/client.js +12 -6
- package/dist/cjs/factory.js +10 -0
- package/dist/cjs/generated/rpc.js +24 -2
- package/dist/cjs/session.js +40 -16
- package/dist/client.js +12 -6
- package/dist/factory.d.ts +24 -34
- package/dist/factory.js +9 -0
- package/dist/generated/rpc.d.ts +404 -130
- package/dist/generated/rpc.js +24 -2
- package/dist/generated/session-events.d.ts +73 -109
- package/dist/index.d.ts +1 -1
- package/dist/session.js +41 -16
- package/dist/types.d.ts +82 -1
- package/docs/factories.md +4 -4
- package/package.json +2 -2
package/dist/generated/rpc.d.ts
CHANGED
|
@@ -4,6 +4,10 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import type { MessageConnection } from "vscode-jsonrpc/node.js";
|
|
6
6
|
import type { AbortReason, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval, Verbosity } from "./session-events.js";
|
|
7
|
+
/** A value that can be represented losslessly on the SDK JSON wire. */
|
|
8
|
+
export type JsonValue = null | boolean | number | string | JsonValue[] | {
|
|
9
|
+
[key: string]: JsonValue;
|
|
10
|
+
};
|
|
7
11
|
/**
|
|
8
12
|
* Initial authentication info for the session.
|
|
9
13
|
*
|
|
@@ -243,6 +247,22 @@ export type AuthInfoType =
|
|
|
243
247
|
| "token"
|
|
244
248
|
/** Authentication from a Copilot API token. */
|
|
245
249
|
| "copilot-api-token";
|
|
250
|
+
/**
|
|
251
|
+
* JSON Schema for canvas open input
|
|
252
|
+
*
|
|
253
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
254
|
+
* via the `definition` "CanvasJsonSchema".
|
|
255
|
+
*/
|
|
256
|
+
/** @experimental */
|
|
257
|
+
export type CanvasJsonSchema = JsonValue;
|
|
258
|
+
/**
|
|
259
|
+
* Provider-supplied action result.
|
|
260
|
+
*
|
|
261
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
262
|
+
* via the `definition` "CanvasActionInvokeResult".
|
|
263
|
+
*/
|
|
264
|
+
/** @experimental */
|
|
265
|
+
export type CanvasActionInvokeResult = JsonValue;
|
|
246
266
|
/**
|
|
247
267
|
* Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command
|
|
248
268
|
*
|
|
@@ -398,6 +418,8 @@ export type DebugCollectLogsResultKind =
|
|
|
398
418
|
"archive"
|
|
399
419
|
/** A directory containing redacted files was written. */
|
|
400
420
|
| "directory";
|
|
421
|
+
/** @experimental */
|
|
422
|
+
export type DisableBypassPermissionsMode = "disable";
|
|
401
423
|
/**
|
|
402
424
|
* Persisted extension discovery source
|
|
403
425
|
*
|
|
@@ -651,6 +673,16 @@ export type FactoryRunFailure = {
|
|
|
651
673
|
*/
|
|
652
674
|
runId: string;
|
|
653
675
|
type: "factory_durable_failure";
|
|
676
|
+
} | {
|
|
677
|
+
/**
|
|
678
|
+
* Factory run identifier.
|
|
679
|
+
*/
|
|
680
|
+
runId: string;
|
|
681
|
+
/**
|
|
682
|
+
* Confirmed usage in nano-AIU, representing the floor of what the run spent.
|
|
683
|
+
*/
|
|
684
|
+
drainedNanoAiu: number;
|
|
685
|
+
type: "factory_accounting_incomplete";
|
|
654
686
|
};
|
|
655
687
|
/**
|
|
656
688
|
* Cumulative resource ceiling that stopped a factory run.
|
|
@@ -1183,6 +1215,63 @@ export type SessionContextAttribution = {
|
|
|
1183
1215
|
* Total token count of the current context window the entries are measured against (system message + conversation messages + tool definitions — the same total reported by /context). Divide an entry's `tokens` by this to derive its share.
|
|
1184
1216
|
*/
|
|
1185
1217
|
totalTokens: number;
|
|
1218
|
+
/**
|
|
1219
|
+
* The concrete model id the entire breakdown was tokenized against (feeds the per-model token multiplier). Under `Auto` (Free/Student) this is the resolved model, not the literal `auto` sentinel, so totals are not undercounted. A single-model approximation of a potentially multi-model Auto session.
|
|
1220
|
+
*/
|
|
1221
|
+
modelId: string;
|
|
1222
|
+
/**
|
|
1223
|
+
* How `modelId` was chosen. Not a closed set — tolerate unknown values. Known values today: `autoResolved` (the model Auto resolved to), `selected` (the user's explicitly selected model), `default` (a fallback before any model is known).
|
|
1224
|
+
*/
|
|
1225
|
+
modelSource: string;
|
|
1226
|
+
/**
|
|
1227
|
+
* Maximum prompt tokens the resolved model accepts — the denominator for a `##k/###k` context-usage display. Mirrors `SessionContextInfo.promptTokenLimit`.
|
|
1228
|
+
*/
|
|
1229
|
+
promptTokenLimit: number;
|
|
1230
|
+
/**
|
|
1231
|
+
* Prompt limit plus the model's output reserve: the full context window `categories.freeSpace` and `categories.buffer` are measured against. Mirrors `SessionContextInfo.limit`.
|
|
1232
|
+
*/
|
|
1233
|
+
limit: number;
|
|
1234
|
+
/**
|
|
1235
|
+
* Output reserve plus the tokens past the buffer-exhaustion blocking threshold. Mirrors `SessionContextInfo.bufferTokens`.
|
|
1236
|
+
*/
|
|
1237
|
+
bufferTokens: number;
|
|
1238
|
+
/**
|
|
1239
|
+
* Token count at which background compaction starts. Mirrors `SessionContextInfo.compactionThreshold`.
|
|
1240
|
+
*/
|
|
1241
|
+
compactionThreshold: number;
|
|
1242
|
+
/**
|
|
1243
|
+
* The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree. Convenience rollups: `freeSpace` and `buffer` describe window capacity rather than occupied context, so the values do not sum to `totalTokens`.
|
|
1244
|
+
*/
|
|
1245
|
+
categories: {
|
|
1246
|
+
/**
|
|
1247
|
+
* System prompt tokens, excluding custom instructions.
|
|
1248
|
+
*/
|
|
1249
|
+
systemPrompt: number;
|
|
1250
|
+
/**
|
|
1251
|
+
* Custom-instructions tokens (0 when none are configured).
|
|
1252
|
+
*/
|
|
1253
|
+
customInstructions: number;
|
|
1254
|
+
/**
|
|
1255
|
+
* Non-MCP tool-definition tokens.
|
|
1256
|
+
*/
|
|
1257
|
+
systemTools: number;
|
|
1258
|
+
/**
|
|
1259
|
+
* MCP tool-definition tokens.
|
|
1260
|
+
*/
|
|
1261
|
+
mcpTools: number;
|
|
1262
|
+
/**
|
|
1263
|
+
* Conversation (user/assistant/tool) message tokens.
|
|
1264
|
+
*/
|
|
1265
|
+
messages: number;
|
|
1266
|
+
/**
|
|
1267
|
+
* Remaining unused window capacity (clamped at 0).
|
|
1268
|
+
*/
|
|
1269
|
+
freeSpace: number;
|
|
1270
|
+
/**
|
|
1271
|
+
* Output reserve plus post-blocking-threshold buffer.
|
|
1272
|
+
*/
|
|
1273
|
+
buffer: number;
|
|
1274
|
+
};
|
|
1186
1275
|
/**
|
|
1187
1276
|
* Flat list of per-source attribution entries. Group by `kind` and render unrecognized kinds generically. Nesting and rollups are expressed via `parentId`.
|
|
1188
1277
|
*/
|
|
@@ -1494,6 +1583,52 @@ export type PermissionDecisionApproveForSessionApproval = PermissionDecisionAppr
|
|
|
1494
1583
|
*/
|
|
1495
1584
|
/** @experimental */
|
|
1496
1585
|
export type PermissionDecisionApproveForLocationApproval = PermissionDecisionApproveForLocationApprovalCommands | PermissionDecisionApproveForLocationApprovalRead | PermissionDecisionApproveForLocationApprovalWrite | PermissionDecisionApproveForLocationApprovalMcp | PermissionDecisionApproveForLocationApprovalMcpSampling | PermissionDecisionApproveForLocationApprovalMemory | PermissionDecisionApproveForLocationApprovalCustomTool | PermissionDecisionApproveForLocationApprovalExtensionManagement | PermissionDecisionApproveForLocationApprovalFactory | PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess;
|
|
1586
|
+
/**
|
|
1587
|
+
* Disposition of a permission request as observed by the responding client.
|
|
1588
|
+
*
|
|
1589
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1590
|
+
* via the `definition` "PermissionDecisionOutcome".
|
|
1591
|
+
*/
|
|
1592
|
+
/** @experimental */
|
|
1593
|
+
export type PermissionDecisionOutcome =
|
|
1594
|
+
/** The request was approved automatically without a new human decision. */
|
|
1595
|
+
"auto_approved"
|
|
1596
|
+
/** The request was denied without an interactive user decision; source records why. */
|
|
1597
|
+
| "autopilot_denied"
|
|
1598
|
+
/** The response came from an interactive user prompt. */
|
|
1599
|
+
| "prompted_user";
|
|
1600
|
+
/**
|
|
1601
|
+
* Controlled reason or actor responsible for a permission response.
|
|
1602
|
+
*
|
|
1603
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1604
|
+
* via the `definition` "PermissionDecisionSource".
|
|
1605
|
+
*/
|
|
1606
|
+
/** @experimental */
|
|
1607
|
+
export type PermissionDecisionSource =
|
|
1608
|
+
/** The response followed the auto-approval judge recommendation. */
|
|
1609
|
+
"judge_recommendation"
|
|
1610
|
+
/** A human supplied the response through an interactive prompt. */
|
|
1611
|
+
| "human_response"
|
|
1612
|
+
/** The host applied a standing policy or override rather than a judge recommendation or human decision. */
|
|
1613
|
+
| "host_policy"
|
|
1614
|
+
/** The host denied the request because no interactive user response was available. */
|
|
1615
|
+
| "unattended_fallback";
|
|
1616
|
+
/**
|
|
1617
|
+
* Client surface that submitted a permission response.
|
|
1618
|
+
*
|
|
1619
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1620
|
+
* via the `definition` "PermissionDecisionSurface".
|
|
1621
|
+
*/
|
|
1622
|
+
/** @experimental */
|
|
1623
|
+
export type PermissionDecisionSurface =
|
|
1624
|
+
/** The interactive Copilot CLI terminal UI. */
|
|
1625
|
+
"tui"
|
|
1626
|
+
/** The non-interactive Copilot CLI prompt mode. */
|
|
1627
|
+
| "prompt_mode"
|
|
1628
|
+
/** The Copilot App client. */
|
|
1629
|
+
| "copilot_app"
|
|
1630
|
+
/** A generic Copilot SDK client. */
|
|
1631
|
+
| "sdk";
|
|
1497
1632
|
/**
|
|
1498
1633
|
* Tool approval to persist and apply
|
|
1499
1634
|
*
|
|
@@ -3272,7 +3407,7 @@ export interface AgentInfo {
|
|
|
3272
3407
|
* @experimental
|
|
3273
3408
|
*/
|
|
3274
3409
|
mcpServers?: {
|
|
3275
|
-
[k: string]:
|
|
3410
|
+
[k: string]: JsonValue | undefined;
|
|
3276
3411
|
};
|
|
3277
3412
|
/**
|
|
3278
3413
|
* Skill names preloaded into this agent's context. Omitted means none.
|
|
@@ -3670,16 +3805,6 @@ export interface CanvasAction {
|
|
|
3670
3805
|
description?: string;
|
|
3671
3806
|
inputSchema?: CanvasJsonSchema;
|
|
3672
3807
|
}
|
|
3673
|
-
/**
|
|
3674
|
-
* JSON Schema for canvas open input
|
|
3675
|
-
*
|
|
3676
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3677
|
-
* via the `definition` "CanvasJsonSchema".
|
|
3678
|
-
*/
|
|
3679
|
-
/** @experimental */
|
|
3680
|
-
export interface CanvasJsonSchema {
|
|
3681
|
-
[k: string]: unknown | undefined;
|
|
3682
|
-
}
|
|
3683
3808
|
/**
|
|
3684
3809
|
* Canvas action invocation parameters.
|
|
3685
3810
|
*
|
|
@@ -3699,19 +3824,7 @@ export interface CanvasActionInvokeRequest {
|
|
|
3699
3824
|
/**
|
|
3700
3825
|
* Action input
|
|
3701
3826
|
*/
|
|
3702
|
-
input?:
|
|
3703
|
-
[k: string]: unknown | undefined;
|
|
3704
|
-
};
|
|
3705
|
-
}
|
|
3706
|
-
/**
|
|
3707
|
-
* Provider-supplied action result.
|
|
3708
|
-
*
|
|
3709
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3710
|
-
* via the `definition` "CanvasActionInvokeResult".
|
|
3711
|
-
*/
|
|
3712
|
-
/** @experimental */
|
|
3713
|
-
export interface CanvasActionInvokeResult {
|
|
3714
|
-
[k: string]: unknown | undefined;
|
|
3827
|
+
input?: JsonValue;
|
|
3715
3828
|
}
|
|
3716
3829
|
/**
|
|
3717
3830
|
* Canvas close parameters.
|
|
@@ -3856,9 +3969,7 @@ export interface OpenCanvasInstance {
|
|
|
3856
3969
|
/**
|
|
3857
3970
|
* Input supplied when the instance was opened
|
|
3858
3971
|
*/
|
|
3859
|
-
input?:
|
|
3860
|
-
[k: string]: unknown | undefined;
|
|
3861
|
-
};
|
|
3972
|
+
input?: JsonValue;
|
|
3862
3973
|
}
|
|
3863
3974
|
/**
|
|
3864
3975
|
* Canvas open parameters.
|
|
@@ -3883,9 +3994,7 @@ export interface CanvasOpenRequest {
|
|
|
3883
3994
|
/**
|
|
3884
3995
|
* Canvas open input
|
|
3885
3996
|
*/
|
|
3886
|
-
input?:
|
|
3887
|
-
[k: string]: unknown | undefined;
|
|
3888
|
-
};
|
|
3997
|
+
input?: JsonValue;
|
|
3889
3998
|
}
|
|
3890
3999
|
/**
|
|
3891
4000
|
* Canvas close parameters sent to the provider.
|
|
@@ -3958,9 +4067,7 @@ export interface CanvasProviderInvokeActionRequest {
|
|
|
3958
4067
|
/**
|
|
3959
4068
|
* Action input
|
|
3960
4069
|
*/
|
|
3961
|
-
input?:
|
|
3962
|
-
[k: string]: unknown | undefined;
|
|
3963
|
-
};
|
|
4070
|
+
input?: JsonValue;
|
|
3964
4071
|
host?: CanvasHostContext;
|
|
3965
4072
|
session?: CanvasSessionContext;
|
|
3966
4073
|
}
|
|
@@ -3991,9 +4098,7 @@ export interface CanvasProviderOpenRequest {
|
|
|
3991
4098
|
/**
|
|
3992
4099
|
* Canvas open input
|
|
3993
4100
|
*/
|
|
3994
|
-
input?:
|
|
3995
|
-
[k: string]: unknown | undefined;
|
|
3996
|
-
};
|
|
4101
|
+
input?: JsonValue;
|
|
3997
4102
|
host?: CanvasHostContext;
|
|
3998
4103
|
session?: CanvasSessionContext;
|
|
3999
4104
|
}
|
|
@@ -4501,7 +4606,7 @@ export interface CurrentToolMetadata {
|
|
|
4501
4606
|
* JSON Schema for tool input
|
|
4502
4607
|
*/
|
|
4503
4608
|
input_schema?: {
|
|
4504
|
-
[k: string]:
|
|
4609
|
+
[k: string]: JsonValue | undefined;
|
|
4505
4610
|
};
|
|
4506
4611
|
/**
|
|
4507
4612
|
* Whether the tool is loaded on demand via tool search
|
|
@@ -4931,10 +5036,63 @@ export interface ExtensionContextPushInput {
|
|
|
4931
5036
|
/**
|
|
4932
5037
|
* Caller-supplied JSON payload (required, may be null but not undefined)
|
|
4933
5038
|
*/
|
|
4934
|
-
payload:
|
|
4935
|
-
|
|
5039
|
+
payload: JsonValue;
|
|
5040
|
+
}
|
|
5041
|
+
/**
|
|
5042
|
+
* Opaque integrator-owned process launch profile for one extension entrypoint.
|
|
5043
|
+
*
|
|
5044
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5045
|
+
* via the `definition` "ExtensionLaunchProfile".
|
|
5046
|
+
*/
|
|
5047
|
+
/** @experimental */
|
|
5048
|
+
export interface ExtensionLaunchProfile {
|
|
5049
|
+
/**
|
|
5050
|
+
* Executable used to launch the extension entrypoint.
|
|
5051
|
+
*/
|
|
5052
|
+
executable: string;
|
|
5053
|
+
/**
|
|
5054
|
+
* Opaque integrator-defined arguments passed to the executable. The runtime does not append the extension entrypoint.
|
|
5055
|
+
*/
|
|
5056
|
+
args: string[];
|
|
5057
|
+
/**
|
|
5058
|
+
* Opaque integrator-defined environment variables. Runtime-owned COPILOT_SDK_PATH, SESSION_ID, and COPILOT_EXTENSION_PARENT_PID values take precedence.
|
|
5059
|
+
*/
|
|
5060
|
+
env: {
|
|
5061
|
+
[k: string]: string | undefined;
|
|
4936
5062
|
};
|
|
4937
5063
|
}
|
|
5064
|
+
/**
|
|
5065
|
+
* A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile.
|
|
5066
|
+
*
|
|
5067
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5068
|
+
* via the `definition` "ExtensionLaunchProviderResolveRequest".
|
|
5069
|
+
*/
|
|
5070
|
+
/** @experimental */
|
|
5071
|
+
export interface ExtensionLaunchProviderResolveRequest {
|
|
5072
|
+
/**
|
|
5073
|
+
* Source-qualified extension identifier.
|
|
5074
|
+
*/
|
|
5075
|
+
id: string;
|
|
5076
|
+
/**
|
|
5077
|
+
* Human-readable extension name.
|
|
5078
|
+
*/
|
|
5079
|
+
name: string;
|
|
5080
|
+
/**
|
|
5081
|
+
* Absolute path to the discovered extension entrypoint.
|
|
5082
|
+
*/
|
|
5083
|
+
modulePath: string;
|
|
5084
|
+
source: ExtensionSource;
|
|
5085
|
+
}
|
|
5086
|
+
/**
|
|
5087
|
+
* The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint.
|
|
5088
|
+
*
|
|
5089
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5090
|
+
* via the `definition` "ExtensionLaunchProviderResolveResult".
|
|
5091
|
+
*/
|
|
5092
|
+
/** @experimental */
|
|
5093
|
+
export interface ExtensionLaunchProviderResolveResult {
|
|
5094
|
+
launch?: ExtensionLaunchProfile;
|
|
5095
|
+
}
|
|
4938
5096
|
/**
|
|
4939
5097
|
* Extensions discovered for the session, with their current status.
|
|
4940
5098
|
*
|
|
@@ -5002,7 +5160,7 @@ export interface ExternalToolTextResultForLlm {
|
|
|
5002
5160
|
* Optional tool-specific telemetry
|
|
5003
5161
|
*/
|
|
5004
5162
|
toolTelemetry?: {
|
|
5005
|
-
[k: string]:
|
|
5163
|
+
[k: string]: JsonValue | undefined;
|
|
5006
5164
|
};
|
|
5007
5165
|
/**
|
|
5008
5166
|
* Base64-encoded binary results returned to the model
|
|
@@ -5042,7 +5200,7 @@ export interface ExternalToolTextResultForLlmBinaryResultsForLlm {
|
|
|
5042
5200
|
* Optional metadata from the producing tool.
|
|
5043
5201
|
*/
|
|
5044
5202
|
metadata?: {
|
|
5045
|
-
[k: string]:
|
|
5203
|
+
[k: string]: JsonValue | undefined;
|
|
5046
5204
|
};
|
|
5047
5205
|
}
|
|
5048
5206
|
/**
|
|
@@ -5280,13 +5438,20 @@ export interface FactoryAgentOptions {
|
|
|
5280
5438
|
/**
|
|
5281
5439
|
* Optional JSON Schema for structured agent output.
|
|
5282
5440
|
*/
|
|
5283
|
-
schema?:
|
|
5284
|
-
[k: string]: unknown | undefined;
|
|
5285
|
-
};
|
|
5441
|
+
schema?: JsonValue;
|
|
5286
5442
|
/**
|
|
5287
5443
|
* Optional model identifier for the subagent.
|
|
5288
5444
|
*/
|
|
5289
5445
|
model?: string;
|
|
5446
|
+
/**
|
|
5447
|
+
* Optional reasoning effort for the subagent. This field is accepted but not yet honored.
|
|
5448
|
+
*/
|
|
5449
|
+
reasoningEffort?: string;
|
|
5450
|
+
contextTier?: ContextTier;
|
|
5451
|
+
/**
|
|
5452
|
+
* Optional custom agent name for the subagent. This field is accepted but not yet honored.
|
|
5453
|
+
*/
|
|
5454
|
+
agent?: string;
|
|
5290
5455
|
}
|
|
5291
5456
|
/**
|
|
5292
5457
|
* Parameters for one factory-scoped subagent call.
|
|
@@ -5321,9 +5486,7 @@ export interface FactoryAgentResult {
|
|
|
5321
5486
|
/**
|
|
5322
5487
|
* Agent result, omitted when the agent produced no result.
|
|
5323
5488
|
*/
|
|
5324
|
-
result?:
|
|
5325
|
-
[k: string]: unknown | undefined;
|
|
5326
|
-
};
|
|
5489
|
+
result?: JsonValue;
|
|
5327
5490
|
}
|
|
5328
5491
|
/**
|
|
5329
5492
|
* Prompt-safe durable identity and live status for a direct factory agent.
|
|
@@ -5411,9 +5574,7 @@ export interface FactoryExecuteRequest {
|
|
|
5411
5574
|
/**
|
|
5412
5575
|
* Factory input value.
|
|
5413
5576
|
*/
|
|
5414
|
-
args:
|
|
5415
|
-
[k: string]: unknown | undefined;
|
|
5416
|
-
};
|
|
5577
|
+
args: JsonValue;
|
|
5417
5578
|
}
|
|
5418
5579
|
/**
|
|
5419
5580
|
* Result returned by an extension factory closure.
|
|
@@ -5426,9 +5587,7 @@ export interface FactoryExecuteResult {
|
|
|
5426
5587
|
/**
|
|
5427
5588
|
* Factory result value.
|
|
5428
5589
|
*/
|
|
5429
|
-
result?:
|
|
5430
|
-
[k: string]: unknown | undefined;
|
|
5431
|
-
};
|
|
5590
|
+
result?: JsonValue;
|
|
5432
5591
|
}
|
|
5433
5592
|
/**
|
|
5434
5593
|
* Parameters for paging factory progress.
|
|
@@ -5508,9 +5667,7 @@ export interface FactoryJournalGetResult {
|
|
|
5508
5667
|
/**
|
|
5509
5668
|
* Cached JSON result. The hit field distinguishes a cached JSON null from a miss.
|
|
5510
5669
|
*/
|
|
5511
|
-
resultJson?:
|
|
5512
|
-
[k: string]: unknown | undefined;
|
|
5513
|
-
};
|
|
5670
|
+
resultJson?: JsonValue;
|
|
5514
5671
|
}
|
|
5515
5672
|
/**
|
|
5516
5673
|
* Parameters for storing a factory journal entry.
|
|
@@ -5535,21 +5692,31 @@ export interface FactoryJournalPutRequest {
|
|
|
5535
5692
|
/**
|
|
5536
5693
|
* JSON result to memoize.
|
|
5537
5694
|
*/
|
|
5538
|
-
resultJson:
|
|
5539
|
-
[k: string]: unknown | undefined;
|
|
5540
|
-
};
|
|
5695
|
+
resultJson: JsonValue;
|
|
5541
5696
|
}
|
|
5542
5697
|
/**
|
|
5543
|
-
*
|
|
5698
|
+
* Parameters for paging factory runs.
|
|
5544
5699
|
*
|
|
5545
5700
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5546
5701
|
* via the `definition` "FactoryListRunsRequest".
|
|
5547
5702
|
*/
|
|
5548
5703
|
/** @experimental */
|
|
5549
5704
|
export interface FactoryListRunsRequest {
|
|
5705
|
+
/**
|
|
5706
|
+
* Exclusive forward cursor.
|
|
5707
|
+
*/
|
|
5708
|
+
afterSeq?: number;
|
|
5709
|
+
/**
|
|
5710
|
+
* Exclusive backward cursor.
|
|
5711
|
+
*/
|
|
5712
|
+
beforeSeq?: number;
|
|
5713
|
+
/**
|
|
5714
|
+
* Maximum terminal runs to return. Defaults to 200 and is capped at 500.
|
|
5715
|
+
*/
|
|
5716
|
+
limit?: number;
|
|
5550
5717
|
}
|
|
5551
5718
|
/**
|
|
5552
|
-
*
|
|
5719
|
+
* A page of factory runs in durable creation order.
|
|
5553
5720
|
*
|
|
5554
5721
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5555
5722
|
* via the `definition` "FactoryListRunsResult".
|
|
@@ -5557,6 +5724,22 @@ export interface FactoryListRunsRequest {
|
|
|
5557
5724
|
/** @experimental */
|
|
5558
5725
|
export interface FactoryListRunsResult {
|
|
5559
5726
|
runs: FactoryRunSummary[];
|
|
5727
|
+
/**
|
|
5728
|
+
* Oldest terminal-run cursor in this page, or null when the terminal window is empty.
|
|
5729
|
+
*/
|
|
5730
|
+
oldestSeq?: number | null;
|
|
5731
|
+
/**
|
|
5732
|
+
* Newest terminal-run cursor in this page, or null when the terminal window is empty.
|
|
5733
|
+
*/
|
|
5734
|
+
newestSeq?: number | null;
|
|
5735
|
+
/**
|
|
5736
|
+
* Whether terminal runs newer than this page exist.
|
|
5737
|
+
*/
|
|
5738
|
+
hasMoreNewer?: boolean;
|
|
5739
|
+
/**
|
|
5740
|
+
* Number of terminal runs older than this page.
|
|
5741
|
+
*/
|
|
5742
|
+
omittedOlder?: number;
|
|
5560
5743
|
}
|
|
5561
5744
|
/**
|
|
5562
5745
|
* Durable factory run summary with read-time live overlays.
|
|
@@ -5789,9 +5972,7 @@ export interface FactoryRunResult {
|
|
|
5789
5972
|
/**
|
|
5790
5973
|
* Completed factory result.
|
|
5791
5974
|
*/
|
|
5792
|
-
result?:
|
|
5793
|
-
[k: string]: unknown | undefined;
|
|
5794
|
-
};
|
|
5975
|
+
result?: JsonValue;
|
|
5795
5976
|
/**
|
|
5796
5977
|
* Error message for an errored run.
|
|
5797
5978
|
*/
|
|
@@ -5804,9 +5985,7 @@ export interface FactoryRunResult {
|
|
|
5804
5985
|
/**
|
|
5805
5986
|
* Partial journal and progress snapshot for a halted, cancelled, or errored run.
|
|
5806
5987
|
*/
|
|
5807
|
-
snapshot?:
|
|
5808
|
-
[k: string]: unknown | undefined;
|
|
5809
|
-
};
|
|
5988
|
+
snapshot?: JsonValue;
|
|
5810
5989
|
}
|
|
5811
5990
|
/**
|
|
5812
5991
|
* Full factory run observability detail.
|
|
@@ -5854,9 +6033,7 @@ export interface FactoryRunRequest {
|
|
|
5854
6033
|
/**
|
|
5855
6034
|
* Factory input value.
|
|
5856
6035
|
*/
|
|
5857
|
-
args:
|
|
5858
|
-
[k: string]: unknown | undefined;
|
|
5859
|
-
};
|
|
6036
|
+
args: JsonValue;
|
|
5860
6037
|
options?: RunOptions;
|
|
5861
6038
|
}
|
|
5862
6039
|
/**
|
|
@@ -7041,6 +7218,23 @@ export interface LspInitializeRequest {
|
|
|
7041
7218
|
*/
|
|
7042
7219
|
force?: boolean;
|
|
7043
7220
|
}
|
|
7221
|
+
/**
|
|
7222
|
+
* Validated device-managed settings discovered before a session exists.
|
|
7223
|
+
*
|
|
7224
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7225
|
+
* via the `definition` "ManagedSettingsReadResult".
|
|
7226
|
+
*/
|
|
7227
|
+
/** @experimental */
|
|
7228
|
+
export interface ManagedSettingsReadResult {
|
|
7229
|
+
/**
|
|
7230
|
+
* Validated, canonical managed-settings JSON. Omitted when no managed settings were discovered or when discovered settings failed validation.
|
|
7231
|
+
*/
|
|
7232
|
+
settingsJson?: JsonValue;
|
|
7233
|
+
/**
|
|
7234
|
+
* Discovery or validation error text when managed settings could not be read safely.
|
|
7235
|
+
*/
|
|
7236
|
+
errorMessage?: string;
|
|
7237
|
+
}
|
|
7044
7238
|
/**
|
|
7045
7239
|
* Result of registering a new marketplace.
|
|
7046
7240
|
*
|
|
@@ -7206,7 +7400,7 @@ export interface McpAppsCallToolRequest {
|
|
|
7206
7400
|
* Tool arguments
|
|
7207
7401
|
*/
|
|
7208
7402
|
arguments?: {
|
|
7209
|
-
[k: string]:
|
|
7403
|
+
[k: string]: JsonValue | undefined;
|
|
7210
7404
|
};
|
|
7211
7405
|
/**
|
|
7212
7406
|
* **Required.** Server whose ui:// view issued the request. Per SEP-1865 ('callable by the app from this server only'), the call is rejected when this differs from `serverName`, and rejected outright when missing.
|
|
@@ -7351,7 +7545,7 @@ export interface McpAppsListToolsResult {
|
|
|
7351
7545
|
* App-callable tools from the server
|
|
7352
7546
|
*/
|
|
7353
7547
|
tools: {
|
|
7354
|
-
[k: string]:
|
|
7548
|
+
[k: string]: JsonValue | undefined;
|
|
7355
7549
|
}[];
|
|
7356
7550
|
}
|
|
7357
7551
|
/**
|
|
@@ -7412,7 +7606,7 @@ export interface McpAppsResourceContent {
|
|
|
7412
7606
|
* Resource-level metadata (CSP, permissions, etc.)
|
|
7413
7607
|
*/
|
|
7414
7608
|
_meta?: {
|
|
7415
|
-
[k: string]:
|
|
7609
|
+
[k: string]: JsonValue | undefined;
|
|
7416
7610
|
};
|
|
7417
7611
|
}
|
|
7418
7612
|
/**
|
|
@@ -7755,9 +7949,7 @@ export interface McpExecuteSamplingParams {
|
|
|
7755
7949
|
/**
|
|
7756
7950
|
* The original MCP JSON-RPC request ID (string or number). Used by the runtime to correlate the inference with the originating MCP request for telemetry; this is distinct from `requestId` (which is the schema-level cancellation handle).
|
|
7757
7951
|
*/
|
|
7758
|
-
mcpRequestId:
|
|
7759
|
-
[k: string]: unknown | undefined;
|
|
7760
|
-
};
|
|
7952
|
+
mcpRequestId: JsonValue;
|
|
7761
7953
|
request: McpExecuteSamplingRequest;
|
|
7762
7954
|
}
|
|
7763
7955
|
/**
|
|
@@ -8166,13 +8358,13 @@ export interface McpResource {
|
|
|
8166
8358
|
* Resource-level metadata
|
|
8167
8359
|
*/
|
|
8168
8360
|
_meta?: {
|
|
8169
|
-
[k: string]:
|
|
8361
|
+
[k: string]: JsonValue | undefined;
|
|
8170
8362
|
};
|
|
8171
8363
|
/**
|
|
8172
8364
|
* Server-provided non-standard descriptor fields preserved from the MCP response
|
|
8173
8365
|
*/
|
|
8174
8366
|
additionalProperties?: {
|
|
8175
|
-
[k: string]:
|
|
8367
|
+
[k: string]: JsonValue | undefined;
|
|
8176
8368
|
};
|
|
8177
8369
|
}
|
|
8178
8370
|
/**
|
|
@@ -8203,7 +8395,7 @@ export interface McpResourceIcon {
|
|
|
8203
8395
|
* Server-provided non-standard icon fields preserved from the MCP response
|
|
8204
8396
|
*/
|
|
8205
8397
|
additionalProperties?: {
|
|
8206
|
-
[k: string]:
|
|
8398
|
+
[k: string]: JsonValue | undefined;
|
|
8207
8399
|
};
|
|
8208
8400
|
}
|
|
8209
8401
|
/**
|
|
@@ -8230,7 +8422,7 @@ export interface McpResourceAnnotations {
|
|
|
8230
8422
|
* Server-provided non-standard annotation fields preserved from the MCP response
|
|
8231
8423
|
*/
|
|
8232
8424
|
additionalProperties?: {
|
|
8233
|
-
[k: string]:
|
|
8425
|
+
[k: string]: JsonValue | undefined;
|
|
8234
8426
|
};
|
|
8235
8427
|
}
|
|
8236
8428
|
/**
|
|
@@ -8261,7 +8453,7 @@ export interface McpResourceContent {
|
|
|
8261
8453
|
* Resource-level metadata (CSP, permissions, etc.)
|
|
8262
8454
|
*/
|
|
8263
8455
|
_meta?: {
|
|
8264
|
-
[k: string]:
|
|
8456
|
+
[k: string]: JsonValue | undefined;
|
|
8265
8457
|
};
|
|
8266
8458
|
}
|
|
8267
8459
|
/**
|
|
@@ -8369,13 +8561,13 @@ export interface McpResourceTemplate {
|
|
|
8369
8561
|
* Resource-template-level metadata
|
|
8370
8562
|
*/
|
|
8371
8563
|
_meta?: {
|
|
8372
|
-
[k: string]:
|
|
8564
|
+
[k: string]: JsonValue | undefined;
|
|
8373
8565
|
};
|
|
8374
8566
|
/**
|
|
8375
8567
|
* Server-provided non-standard descriptor fields preserved from the MCP response
|
|
8376
8568
|
*/
|
|
8377
8569
|
additionalProperties?: {
|
|
8378
|
-
[k: string]:
|
|
8570
|
+
[k: string]: JsonValue | undefined;
|
|
8379
8571
|
};
|
|
8380
8572
|
}
|
|
8381
8573
|
/**
|
|
@@ -9324,7 +9516,7 @@ export interface NameSetRequest {
|
|
|
9324
9516
|
/** @experimental */
|
|
9325
9517
|
export interface OptionsUpdateAdditionalContentExclusionPolicy {
|
|
9326
9518
|
rules: OptionsUpdateAdditionalContentExclusionPolicyRule[];
|
|
9327
|
-
last_updated_at:
|
|
9519
|
+
last_updated_at: JsonValue;
|
|
9328
9520
|
scope: OptionsUpdateAdditionalContentExclusionPolicyScope;
|
|
9329
9521
|
}
|
|
9330
9522
|
/**
|
|
@@ -9957,6 +10149,18 @@ export interface PermissionDecisionDeniedByPermissionRequestHook {
|
|
|
9957
10149
|
*/
|
|
9958
10150
|
interrupt?: boolean;
|
|
9959
10151
|
}
|
|
10152
|
+
/**
|
|
10153
|
+
* Optional informational context describing how and where the permission decision was made. This does not affect permission behavior.
|
|
10154
|
+
*
|
|
10155
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10156
|
+
* via the `definition` "PermissionDecisionContext".
|
|
10157
|
+
*/
|
|
10158
|
+
/** @experimental */
|
|
10159
|
+
export interface PermissionDecisionContext {
|
|
10160
|
+
outcome: PermissionDecisionOutcome;
|
|
10161
|
+
source: PermissionDecisionSource;
|
|
10162
|
+
surface: PermissionDecisionSurface;
|
|
10163
|
+
}
|
|
9960
10164
|
/**
|
|
9961
10165
|
* Pending permission request ID and the decision to apply (approve/reject and scope).
|
|
9962
10166
|
*
|
|
@@ -9970,6 +10174,7 @@ export interface PermissionDecisionRequest {
|
|
|
9970
10174
|
*/
|
|
9971
10175
|
requestId: string;
|
|
9972
10176
|
result: PermissionDecision;
|
|
10177
|
+
decisionContext?: PermissionDecisionContext;
|
|
9973
10178
|
}
|
|
9974
10179
|
/**
|
|
9975
10180
|
* Location-scoped tool approval to persist.
|
|
@@ -10389,7 +10594,7 @@ export interface PermissionRulesSet {
|
|
|
10389
10594
|
/** @experimental */
|
|
10390
10595
|
export interface PermissionsConfigureAdditionalContentExclusionPolicy {
|
|
10391
10596
|
rules: PermissionsConfigureAdditionalContentExclusionPolicyRule[];
|
|
10392
|
-
last_updated_at:
|
|
10597
|
+
last_updated_at: JsonValue;
|
|
10393
10598
|
scope: PermissionsConfigureAdditionalContentExclusionPolicyScope;
|
|
10394
10599
|
}
|
|
10395
10600
|
/**
|
|
@@ -11202,7 +11407,7 @@ export interface ProviderAddResult {
|
|
|
11202
11407
|
/**
|
|
11203
11408
|
* Synthesized selectable model entries for the newly added BYOK models, each under its provider-qualified selection id (`provider/id`). Empty when only providers were added.
|
|
11204
11409
|
*/
|
|
11205
|
-
models:
|
|
11410
|
+
models: JsonValue[];
|
|
11206
11411
|
}
|
|
11207
11412
|
/**
|
|
11208
11413
|
* Custom model-provider configuration (BYOK).
|
|
@@ -11837,9 +12042,7 @@ export interface QueueConsumeSystemNotificationsRequest {
|
|
|
11837
12042
|
/**
|
|
11838
12043
|
* Opaque runtime-owned filter object.
|
|
11839
12044
|
*/
|
|
11840
|
-
filter:
|
|
11841
|
-
[k: string]: unknown | undefined;
|
|
11842
|
-
};
|
|
12045
|
+
filter: JsonValue;
|
|
11843
12046
|
}
|
|
11844
12047
|
/**
|
|
11845
12048
|
* Inputs for marking session.idle deferred in native state.
|
|
@@ -12589,18 +12792,11 @@ export interface SandboxConfig {
|
|
|
12589
12792
|
* Whether to auto-add the current working directory to readwritePaths. Default: true.
|
|
12590
12793
|
*/
|
|
12591
12794
|
addCurrentWorkingDirectory?: boolean;
|
|
12795
|
+
auth?: SandboxConfigAuth;
|
|
12592
12796
|
/**
|
|
12593
|
-
* Whether to
|
|
12594
|
-
*/
|
|
12595
|
-
gitAuth?: boolean;
|
|
12596
|
-
/**
|
|
12597
|
-
* Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the OS keyring the sandbox blocks. Default: false (opt-in).
|
|
12598
|
-
*/
|
|
12599
|
-
ghAuth?: boolean;
|
|
12600
|
-
/**
|
|
12601
|
-
* Whether to auto-grant read access to common developer-tool caches, registries, and toolchains in their default home locations (cargo, go, npm, Maven, and more), plus read-write access to (and, on Unix, up-front creation of) the scratch caches builds write on every run (go-build, ccache, sccache, Gradle caches, Cargo lock/tracker files), so builds work without exporting CARGO_HOME/GOPATH/etc. Default: true (enabled by default; set to false to opt out).
|
|
12797
|
+
* Whether to auto-grant read access to common developer-tool caches, registries, and toolchains in their default home locations (cargo, go, npm, Maven, and more), plus read-write access to (and, on Unix, up-front creation of) the scratch caches builds write on every run (go-build, ccache, sccache, Gradle caches, Cargo lock/tracker files), so builds work without extra configuration; a relocated CARGO_HOME additionally gets its Cargo lock files granted read-write. Default: true (enabled by default; set to false to opt out).
|
|
12602
12798
|
*/
|
|
12603
|
-
|
|
12799
|
+
allowDevToolAccess?: boolean;
|
|
12604
12800
|
}
|
|
12605
12801
|
/**
|
|
12606
12802
|
* User-managed sandbox policy fragment merged into the auto-discovered base policy.
|
|
@@ -12715,6 +12911,23 @@ export interface SandboxConfigUserPolicyExperimentalSeatbelt {
|
|
|
12715
12911
|
*/
|
|
12716
12912
|
keychainAccess?: boolean;
|
|
12717
12913
|
}
|
|
12914
|
+
/**
|
|
12915
|
+
* Credential-injection capability flags applied while the sandbox is enabled.
|
|
12916
|
+
*
|
|
12917
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12918
|
+
* via the `definition` "SandboxConfigAuth".
|
|
12919
|
+
*/
|
|
12920
|
+
/** @experimental */
|
|
12921
|
+
export interface SandboxConfigAuth {
|
|
12922
|
+
/**
|
|
12923
|
+
* Whether to inject git credentials as an `http.<url>.extraheader` so authenticated HTTPS git works inside the sandbox without the shell-based credential helper the sandbox blocks. github.com is served by the Copilot token; every other forge (Azure DevOps, GitHub Enterprise Server, GitLab, ...) by a credential the host resolves from the user's own helper before the sandbox is applied. Default: false (opt-in).
|
|
12924
|
+
*/
|
|
12925
|
+
git?: boolean;
|
|
12926
|
+
/**
|
|
12927
|
+
* Whether to export `GH_TOKEN` so the `gh` CLI authenticates inside the sandbox without the OS keyring the sandbox blocks. Default: false (opt-in).
|
|
12928
|
+
*/
|
|
12929
|
+
gh?: boolean;
|
|
12930
|
+
}
|
|
12718
12931
|
/**
|
|
12719
12932
|
* Register an absolute-time scheduled prompt.
|
|
12720
12933
|
*
|
|
@@ -13139,15 +13352,11 @@ export interface SendSystemNotificationRequest {
|
|
|
13139
13352
|
/**
|
|
13140
13353
|
* Optional structured notification kind.
|
|
13141
13354
|
*/
|
|
13142
|
-
kind?:
|
|
13143
|
-
[k: string]: unknown | undefined;
|
|
13144
|
-
};
|
|
13355
|
+
kind?: JsonValue;
|
|
13145
13356
|
/**
|
|
13146
13357
|
* Internal delivery options, including passive policy.
|
|
13147
13358
|
*/
|
|
13148
|
-
options?:
|
|
13149
|
-
[k: string]: unknown | undefined;
|
|
13150
|
-
};
|
|
13359
|
+
options?: JsonValue;
|
|
13151
13360
|
}
|
|
13152
13361
|
/**
|
|
13153
13362
|
* Agents discovered across user, project, plugin, and remote sources.
|
|
@@ -13187,6 +13396,10 @@ export interface ServerSkill {
|
|
|
13187
13396
|
* Unique identifier for the skill
|
|
13188
13397
|
*/
|
|
13189
13398
|
name: string;
|
|
13399
|
+
/**
|
|
13400
|
+
* Canonical slash command name used to invoke the skill, without the leading '/'
|
|
13401
|
+
*/
|
|
13402
|
+
commandName?: string;
|
|
13190
13403
|
/**
|
|
13191
13404
|
* Description of what the skill does
|
|
13192
13405
|
*/
|
|
@@ -13631,7 +13844,7 @@ export interface SessionFsSqliteQueryRequest {
|
|
|
13631
13844
|
* Optional named bind parameters
|
|
13632
13845
|
*/
|
|
13633
13846
|
params?: {
|
|
13634
|
-
[k: string]:
|
|
13847
|
+
[k: string]: JsonValue | undefined;
|
|
13635
13848
|
};
|
|
13636
13849
|
}
|
|
13637
13850
|
/**
|
|
@@ -13646,7 +13859,7 @@ export interface SessionFsSqliteQueryResult {
|
|
|
13646
13859
|
* For SELECT: array of row objects. For others: empty array.
|
|
13647
13860
|
*/
|
|
13648
13861
|
rows: {
|
|
13649
|
-
[k: string]:
|
|
13862
|
+
[k: string]: JsonValue | undefined;
|
|
13650
13863
|
}[];
|
|
13651
13864
|
/**
|
|
13652
13865
|
* Column names from the result set
|
|
@@ -13704,7 +13917,7 @@ export interface SessionFsSqliteTransactionStatement {
|
|
|
13704
13917
|
* Optional named bind parameters.
|
|
13705
13918
|
*/
|
|
13706
13919
|
params?: {
|
|
13707
|
-
[k: string]:
|
|
13920
|
+
[k: string]: JsonValue | undefined;
|
|
13708
13921
|
};
|
|
13709
13922
|
}
|
|
13710
13923
|
/**
|
|
@@ -14001,6 +14214,38 @@ export interface SessionLoadDeferredRepoHooksResult {
|
|
|
14001
14214
|
*/
|
|
14002
14215
|
hookCount: number;
|
|
14003
14216
|
}
|
|
14217
|
+
/**
|
|
14218
|
+
* Enterprise permission policy expressed with the runtime's managed permission-rule syntax.
|
|
14219
|
+
*
|
|
14220
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14221
|
+
* via the `definition` "SessionManagedPermissions".
|
|
14222
|
+
*/
|
|
14223
|
+
/** @experimental */
|
|
14224
|
+
export interface SessionManagedPermissions {
|
|
14225
|
+
disableBypassPermissionsMode?: DisableBypassPermissionsMode;
|
|
14226
|
+
/**
|
|
14227
|
+
* Permission rules that block matching operations. Deny has highest precedence.
|
|
14228
|
+
*/
|
|
14229
|
+
deny?: string[];
|
|
14230
|
+
/**
|
|
14231
|
+
* Permission rules that require explicit human approval.
|
|
14232
|
+
*/
|
|
14233
|
+
ask?: string[];
|
|
14234
|
+
/**
|
|
14235
|
+
* Permission rules that allow matching operations unless another managed source, deny, or ask rule restricts them.
|
|
14236
|
+
*/
|
|
14237
|
+
allow?: string[];
|
|
14238
|
+
}
|
|
14239
|
+
/**
|
|
14240
|
+
* Managed settings an SDK host may inject at session startup. Only permissions are accepted in this initial contract.
|
|
14241
|
+
*
|
|
14242
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14243
|
+
* via the `definition` "SessionManagedSettings".
|
|
14244
|
+
*/
|
|
14245
|
+
/** @experimental */
|
|
14246
|
+
export interface SessionManagedSettings {
|
|
14247
|
+
permissions?: SessionManagedPermissions;
|
|
14248
|
+
}
|
|
14004
14249
|
/**
|
|
14005
14250
|
* Point-in-time snapshot of slow-changing session identifier and state fields
|
|
14006
14251
|
*
|
|
@@ -14075,7 +14320,7 @@ export interface SessionModelList {
|
|
|
14075
14320
|
/**
|
|
14076
14321
|
* Available models, ordered with the most preferred default first. Includes both Copilot (CAPI) models and any registry BYOK models; a BYOK model appears under its provider-qualified selection id (`provider/id`).
|
|
14077
14322
|
*/
|
|
14078
|
-
list:
|
|
14323
|
+
list: JsonValue[];
|
|
14079
14324
|
/**
|
|
14080
14325
|
* Cost categories for the full CAPI catalog, including picker-disabled models that Auto may select. Metadata only; entries absent from `list` are not manually selectable.
|
|
14081
14326
|
*/
|
|
@@ -14084,7 +14329,7 @@ export interface SessionModelList {
|
|
|
14084
14329
|
* Per-quota snapshots returned alongside the model list, keyed by quota type.
|
|
14085
14330
|
*/
|
|
14086
14331
|
quotaSnapshots?: {
|
|
14087
|
-
[k: string]:
|
|
14332
|
+
[k: string]: JsonValue | undefined;
|
|
14088
14333
|
};
|
|
14089
14334
|
}
|
|
14090
14335
|
/**
|
|
@@ -14144,6 +14389,7 @@ export interface SessionOpenOptions {
|
|
|
14144
14389
|
* Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap.
|
|
14145
14390
|
*/
|
|
14146
14391
|
enableManagedSettings?: boolean;
|
|
14392
|
+
managedSettings?: SessionManagedSettings;
|
|
14147
14393
|
/**
|
|
14148
14394
|
* 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.
|
|
14149
14395
|
*/
|
|
@@ -14238,6 +14484,10 @@ export interface SessionOpenOptions {
|
|
|
14238
14484
|
*/
|
|
14239
14485
|
logInteractiveShells?: boolean;
|
|
14240
14486
|
envValueMode?: SessionOpenOptionsEnvValueMode;
|
|
14487
|
+
/**
|
|
14488
|
+
* MCP server names disabled for this session. Disabled servers are not started or authenticated on create or cold resume.
|
|
14489
|
+
*/
|
|
14490
|
+
disabledMcpServers?: string[];
|
|
14241
14491
|
/**
|
|
14242
14492
|
* Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers.
|
|
14243
14493
|
*/
|
|
@@ -14389,7 +14639,7 @@ export interface ShellInitScript {
|
|
|
14389
14639
|
/** @experimental */
|
|
14390
14640
|
export interface SessionOpenOptionsAdditionalContentExclusionPolicy {
|
|
14391
14641
|
rules: SessionOpenOptionsAdditionalContentExclusionPolicyRule[];
|
|
14392
|
-
last_updated_at:
|
|
14642
|
+
last_updated_at: JsonValue;
|
|
14393
14643
|
scope: SessionOpenOptionsAdditionalContentExclusionPolicyScope;
|
|
14394
14644
|
}
|
|
14395
14645
|
/**
|
|
@@ -15689,6 +15939,10 @@ export interface Skill {
|
|
|
15689
15939
|
* Unique identifier for the skill
|
|
15690
15940
|
*/
|
|
15691
15941
|
name: string;
|
|
15942
|
+
/**
|
|
15943
|
+
* Canonical slash command name used to invoke the skill, without the leading '/'
|
|
15944
|
+
*/
|
|
15945
|
+
commandName?: string;
|
|
15692
15946
|
/**
|
|
15693
15947
|
* Description of what the skill does
|
|
15694
15948
|
*/
|
|
@@ -16507,7 +16761,7 @@ export interface Tool {
|
|
|
16507
16761
|
* JSON Schema for the tool's input parameters
|
|
16508
16762
|
*/
|
|
16509
16763
|
parameters?: {
|
|
16510
|
-
[k: string]:
|
|
16764
|
+
[k: string]: JsonValue | undefined;
|
|
16511
16765
|
};
|
|
16512
16766
|
/**
|
|
16513
16767
|
* Optional instructions for how to use this tool effectively
|
|
@@ -17387,15 +17641,11 @@ export interface UserSettingMetadata {
|
|
|
17387
17641
|
/**
|
|
17388
17642
|
* The effective value: the user's value if set, otherwise the default.
|
|
17389
17643
|
*/
|
|
17390
|
-
value:
|
|
17391
|
-
[k: string]: unknown | undefined;
|
|
17392
|
-
};
|
|
17644
|
+
value: JsonValue;
|
|
17393
17645
|
/**
|
|
17394
17646
|
* The centrally-known default for this setting (null when no default is registered).
|
|
17395
17647
|
*/
|
|
17396
|
-
default:
|
|
17397
|
-
[k: string]: unknown | undefined;
|
|
17398
|
-
};
|
|
17648
|
+
default: JsonValue;
|
|
17399
17649
|
/**
|
|
17400
17650
|
* True when the user has not set an explicit value for this setting (i.e. it is left at its default). Reflects whether the user has overridden the key, not whether the effective value happens to equal the default — a key explicitly set to a value identical to the default still reports false.
|
|
17401
17651
|
*/
|
|
@@ -17427,9 +17677,7 @@ export interface UserSettingsSetRequest {
|
|
|
17427
17677
|
/**
|
|
17428
17678
|
* Partial user settings to write, as a free-form object keyed by setting name
|
|
17429
17679
|
*/
|
|
17430
|
-
settings:
|
|
17431
|
-
[k: string]: unknown | undefined;
|
|
17432
|
-
};
|
|
17680
|
+
settings: JsonValue;
|
|
17433
17681
|
}
|
|
17434
17682
|
/**
|
|
17435
17683
|
* Outcome of writing user settings.
|
|
@@ -17658,9 +17906,7 @@ export interface WorkspacesEnsureRequest {
|
|
|
17658
17906
|
/**
|
|
17659
17907
|
* Opaque workspace context supplied by the session host.
|
|
17660
17908
|
*/
|
|
17661
|
-
context?:
|
|
17662
|
-
[k: string]: unknown | undefined;
|
|
17663
|
-
};
|
|
17909
|
+
context?: JsonValue;
|
|
17664
17910
|
}
|
|
17665
17911
|
/**
|
|
17666
17912
|
* Current workspace metadata for the session, including its absolute filesystem path when available.
|
|
@@ -17851,9 +18097,7 @@ export interface WorkspacesUpdateMetadataRequest {
|
|
|
17851
18097
|
/**
|
|
17852
18098
|
* Opaque workspace context supplied by the session host.
|
|
17853
18099
|
*/
|
|
17854
|
-
context?:
|
|
17855
|
-
[k: string]: unknown | undefined;
|
|
17856
|
-
};
|
|
18100
|
+
context?: JsonValue;
|
|
17857
18101
|
/**
|
|
17858
18102
|
* Optional workspace display name override.
|
|
17859
18103
|
*/
|
|
@@ -17911,7 +18155,7 @@ export interface SessionAgentListRequest {
|
|
|
17911
18155
|
*/
|
|
17912
18156
|
/** @experimental */
|
|
17913
18157
|
export interface SessionMcpAppsCallToolResult {
|
|
17914
|
-
[k: string]:
|
|
18158
|
+
[k: string]: JsonValue | undefined;
|
|
17915
18159
|
}
|
|
17916
18160
|
/** @experimental */
|
|
17917
18161
|
export interface SessionPluginsReloadRequest {
|
|
@@ -18161,6 +18405,12 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
18161
18405
|
*/
|
|
18162
18406
|
disable: (params: DiscoveredExtensionsDisableRequest) => Promise<void>;
|
|
18163
18407
|
};
|
|
18408
|
+
/**
|
|
18409
|
+
* Registers the calling SDK client as the per-entrypoint extension launch provider. Call before creating any sessions. When omitted, the runtime temporarily falls back to its built-in Node launcher for backward compatibility.
|
|
18410
|
+
*
|
|
18411
|
+
* @experimental
|
|
18412
|
+
*/
|
|
18413
|
+
registerExtensionLaunchProvider: () => Promise<void>;
|
|
18164
18414
|
/** @experimental */
|
|
18165
18415
|
plugins: {
|
|
18166
18416
|
/**
|
|
@@ -18351,6 +18601,15 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
18351
18601
|
};
|
|
18352
18602
|
};
|
|
18353
18603
|
/** @experimental */
|
|
18604
|
+
managedSettings: {
|
|
18605
|
+
/**
|
|
18606
|
+
* Discovers device-managed settings from production MDM and managed-file sources, validates them against the runtime-owned managed-settings schema, and returns the canonical JSON without requiring a session.
|
|
18607
|
+
*
|
|
18608
|
+
* @returns Validated device-managed settings discovered before a session exists.
|
|
18609
|
+
*/
|
|
18610
|
+
read: () => Promise<ManagedSettingsReadResult>;
|
|
18611
|
+
};
|
|
18612
|
+
/** @experimental */
|
|
18354
18613
|
runtime: {
|
|
18355
18614
|
/**
|
|
18356
18615
|
* Gracefully shuts down an SDK-owned runtime. The response is sent only after cleanup completes; callers may then terminate the owned runtime process.
|
|
@@ -18749,9 +19008,11 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
18749
19008
|
/**
|
|
18750
19009
|
* Lists durable factory runs for this session in creation order.
|
|
18751
19010
|
*
|
|
18752
|
-
* @
|
|
19011
|
+
* @param params Parameters for paging factory runs.
|
|
19012
|
+
*
|
|
19013
|
+
* @returns A page of factory runs in durable creation order.
|
|
18753
19014
|
*/
|
|
18754
|
-
listRuns: () => Promise<FactoryListRunsResult>;
|
|
19015
|
+
listRuns: (params: FactoryListRunsRequest) => Promise<FactoryListRunsResult>;
|
|
18755
19016
|
/**
|
|
18756
19017
|
* Gets durable and live observability detail for one factory run.
|
|
18757
19018
|
*
|
|
@@ -20428,6 +20689,18 @@ export interface ClientSessionApiHandlers {
|
|
|
20428
20689
|
* function uses `getHandlers` to resolve the session's handlers.
|
|
20429
20690
|
*/
|
|
20430
20691
|
export declare function registerClientSessionApiHandlers(connection: MessageConnection, getHandlers: (sessionId: string) => ClientSessionApiHandlers): void;
|
|
20692
|
+
/** Handler for `extensionLaunchProvider` client global API methods. */
|
|
20693
|
+
/** @experimental */
|
|
20694
|
+
export interface ExtensionLaunchProviderHandler {
|
|
20695
|
+
/**
|
|
20696
|
+
* Asks the registered SDK client to resolve an opaque process launch profile for one discovered extension entrypoint immediately before launch or reload. The provider must respond within 15 seconds.
|
|
20697
|
+
*
|
|
20698
|
+
* @param params A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile.
|
|
20699
|
+
*
|
|
20700
|
+
* @returns The launch profile for a supported entrypoint. Omit launch when the provider does not support the entrypoint.
|
|
20701
|
+
*/
|
|
20702
|
+
resolve(params: ExtensionLaunchProviderResolveRequest): Promise<ExtensionLaunchProviderResolveResult>;
|
|
20703
|
+
}
|
|
20431
20704
|
/** Handler for `llmInference` client global API methods. */
|
|
20432
20705
|
/** @experimental */
|
|
20433
20706
|
export interface LlmInferenceHandler {
|
|
@@ -20460,6 +20733,7 @@ export interface GitHubTelemetryHandler {
|
|
|
20460
20733
|
}
|
|
20461
20734
|
/** All client global API handler groups. */
|
|
20462
20735
|
export interface ClientGlobalApiHandlers {
|
|
20736
|
+
extensionLaunchProvider?: ExtensionLaunchProviderHandler;
|
|
20463
20737
|
llmInference?: LlmInferenceHandler;
|
|
20464
20738
|
gitHubTelemetry?: GitHubTelemetryHandler;
|
|
20465
20739
|
}
|