@github/copilot-sdk 1.0.14-preview.0 → 1.0.14-unstable.35049111350.g7f86a90
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 +4 -0
- package/dist/cjs/cliVersion.js +1 -1
- package/dist/cjs/factory.js +1 -0
- package/dist/cjs/generated/rpc.js +30 -12
- package/dist/cjs/session.js +55 -8
- package/dist/cliVersion.d.ts +1 -1
- package/dist/cliVersion.js +1 -1
- package/dist/factory.d.ts +42 -16
- package/dist/factory.js +1 -0
- package/dist/generated/rpc.d.ts +358 -28
- package/dist/generated/rpc.js +30 -12
- package/dist/generated/session-events.d.ts +61 -27
- package/dist/index.d.ts +1 -1
- package/dist/session.d.ts +1 -0
- package/dist/session.js +56 -9
- package/docs/factories.md +36 -19
- package/package.json +12 -10
package/dist/generated/rpc.d.ts
CHANGED
|
@@ -38,8 +38,10 @@ export type AdaptiveThinkingSupport =
|
|
|
38
38
|
"unsupported"
|
|
39
39
|
/** The model accepts adaptive thinking but also accepts thinking.type='enabled' */
|
|
40
40
|
| "optional"
|
|
41
|
-
/** The model
|
|
42
|
-
| "required"
|
|
41
|
+
/** The model defaults to adaptive thinking and rejects thinking.type='enabled' with HTTP 400, but still accepts thinking.type='disabled' (e.g. opus-4.7/4.8/5, sonnet-5) */
|
|
42
|
+
| "required"
|
|
43
|
+
/** The model accepts only thinking.type='adaptive'; 'enabled', 'disabled', and an omitted thinking block all fail with HTTP 400 (e.g. fable, mythos) */
|
|
44
|
+
| "adaptive_only";
|
|
43
45
|
/**
|
|
44
46
|
* Which tier this directory belongs to
|
|
45
47
|
*
|
|
@@ -899,7 +901,7 @@ export type DebugCollectLogsSource =
|
|
|
899
901
|
/** Caller-provided diagnostic entry. */
|
|
900
902
|
| "additional";
|
|
901
903
|
/**
|
|
902
|
-
* Destination for the
|
|
904
|
+
* Destination for the session debug bundle.
|
|
903
905
|
*
|
|
904
906
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
905
907
|
* via the `definition` "DebugCollectLogsDestination".
|
|
@@ -920,7 +922,7 @@ export type DebugCollectLogsDestination = {
|
|
|
920
922
|
kind: "archive";
|
|
921
923
|
} | {
|
|
922
924
|
/**
|
|
923
|
-
* Directory where
|
|
925
|
+
* Directory where files should be staged. The directory is created if needed.
|
|
924
926
|
*/
|
|
925
927
|
outputDirectory: string;
|
|
926
928
|
/**
|
|
@@ -951,7 +953,9 @@ export type DebugCollectLogsRedaction =
|
|
|
951
953
|
/** Redact the file as plain UTF-8 log text. */
|
|
952
954
|
"plain-text"
|
|
953
955
|
/** Redact each non-empty line as a session event JSON object, falling back to plain-text redaction for malformed lines. */
|
|
954
|
-
| "events-jsonl"
|
|
956
|
+
| "events-jsonl"
|
|
957
|
+
/** No redaction is applied. The caller must ensure any necessary redaction is performed before this call. */
|
|
958
|
+
| "none";
|
|
955
959
|
/**
|
|
956
960
|
* Destination kind that was written.
|
|
957
961
|
*
|
|
@@ -962,7 +966,7 @@ export type DebugCollectLogsRedaction =
|
|
|
962
966
|
export type DebugCollectLogsResultKind =
|
|
963
967
|
/** A .tgz archive was written. */
|
|
964
968
|
"archive"
|
|
965
|
-
/** A directory containing
|
|
969
|
+
/** A directory containing the collected files was written. */
|
|
966
970
|
| "directory";
|
|
967
971
|
/**
|
|
968
972
|
* Persisted extension discovery source
|
|
@@ -1860,6 +1864,10 @@ export type McpHeadersHandlePendingHeadersRefreshRequest = {
|
|
|
1860
1864
|
headers: {
|
|
1861
1865
|
[k: string]: string | undefined;
|
|
1862
1866
|
};
|
|
1867
|
+
/**
|
|
1868
|
+
* Optional lifetime in milliseconds for these returned headers. The runtime clamps its configured cache lifetime to this value.
|
|
1869
|
+
*/
|
|
1870
|
+
ttlMs?: number;
|
|
1863
1871
|
/**
|
|
1864
1872
|
* Headers-refresh response variant discriminator.
|
|
1865
1873
|
*/
|
|
@@ -1869,6 +1877,15 @@ export type McpHeadersHandlePendingHeadersRefreshRequest = {
|
|
|
1869
1877
|
* Headers-refresh response variant discriminator.
|
|
1870
1878
|
*/
|
|
1871
1879
|
kind: "none";
|
|
1880
|
+
} | {
|
|
1881
|
+
/**
|
|
1882
|
+
* Host credential broker failure, denial, or revocation reason.
|
|
1883
|
+
*/
|
|
1884
|
+
message: string;
|
|
1885
|
+
/**
|
|
1886
|
+
* Headers-refresh response variant discriminator.
|
|
1887
|
+
*/
|
|
1888
|
+
kind: "error";
|
|
1872
1889
|
};
|
|
1873
1890
|
/**
|
|
1874
1891
|
* One eligible way to run the server, represented as a tagged package or remote variant so package identity and endpoint states cannot contradict the install method.
|
|
@@ -2696,6 +2713,8 @@ export type PermissionModeSource =
|
|
|
2696
2713
|
| "autopilot_confirmation"
|
|
2697
2714
|
/** The mode was set at startup by the `defaultPermissionMode` user setting. */
|
|
2698
2715
|
| "user_setting"
|
|
2716
|
+
/** The mode was set at startup by authenticated organization targeting. */
|
|
2717
|
+
| "organization_targeting"
|
|
2699
2718
|
/** The mode was set through an RPC caller. */
|
|
2700
2719
|
| "rpc";
|
|
2701
2720
|
/**
|
|
@@ -2783,6 +2802,10 @@ export type PluginsReloadRequest = {
|
|
|
2783
2802
|
*/
|
|
2784
2803
|
deferRepoHooks?: boolean;
|
|
2785
2804
|
};
|
|
2805
|
+
/** @experimental */
|
|
2806
|
+
export type ProtocolAppendMode = "append";
|
|
2807
|
+
/** @experimental */
|
|
2808
|
+
export type ProtocolCustomizeMode = "customize";
|
|
2786
2809
|
/**
|
|
2787
2810
|
* Controls whether the runtime may defer loading an external tool definition.
|
|
2788
2811
|
*
|
|
@@ -2795,6 +2818,34 @@ export type ProtocolExternalToolDefer =
|
|
|
2795
2818
|
"auto"
|
|
2796
2819
|
/** The runtime must include the tool without deferring it. */
|
|
2797
2820
|
| "never";
|
|
2821
|
+
/** @experimental */
|
|
2822
|
+
export type ProtocolMarkerSectionOverride = {
|
|
2823
|
+
/**
|
|
2824
|
+
* Section override action discriminator.
|
|
2825
|
+
*/
|
|
2826
|
+
action: "transform";
|
|
2827
|
+
} | {
|
|
2828
|
+
/**
|
|
2829
|
+
* Section override action discriminator.
|
|
2830
|
+
*/
|
|
2831
|
+
action: "preserve";
|
|
2832
|
+
};
|
|
2833
|
+
/** @experimental */
|
|
2834
|
+
export type ProtocolReplaceMode = "replace";
|
|
2835
|
+
/** @experimental */
|
|
2836
|
+
export type ProtocolSectionOverride = ProtocolStaticSectionOverride | ProtocolMarkerSectionOverride;
|
|
2837
|
+
/** @experimental */
|
|
2838
|
+
export type ProtocolStaticSectionAction =
|
|
2839
|
+
/** Replace the section content. */
|
|
2840
|
+
"replace"
|
|
2841
|
+
/** Remove the section content. */
|
|
2842
|
+
| "remove"
|
|
2843
|
+
/** Append content to the section. */
|
|
2844
|
+
| "append"
|
|
2845
|
+
/** Prepend content to the section. */
|
|
2846
|
+
| "prepend";
|
|
2847
|
+
/** @experimental */
|
|
2848
|
+
export type ProtocolSystemMessageConfig = ProtocolSystemMessageAppendConfig | ProtocolSystemMessageReplaceConfig | ProtocolSystemMessageCustomizeConfig;
|
|
2798
2849
|
/**
|
|
2799
2850
|
* Provider family. Matches the `type` field of a BYOK provider config.
|
|
2800
2851
|
*
|
|
@@ -2960,6 +3011,32 @@ export type RemoteSessionMetadataTaskType =
|
|
|
2960
3011
|
"cca"
|
|
2961
3012
|
/** CLI remote task. */
|
|
2962
3013
|
| "cli";
|
|
3014
|
+
/**
|
|
3015
|
+
* Provider-native structured output format. JSON Schema is forwarded without rewriting or validating the schema or the generated output.
|
|
3016
|
+
*
|
|
3017
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3018
|
+
* via the `definition` "ResponseFormat".
|
|
3019
|
+
*/
|
|
3020
|
+
/** @experimental */
|
|
3021
|
+
export type ResponseFormat = {
|
|
3022
|
+
jsonSchema: JsonSchemaResponseFormat;
|
|
3023
|
+
/**
|
|
3024
|
+
* Output format discriminator. Currently only json_schema is supported.
|
|
3025
|
+
*/
|
|
3026
|
+
type: "json_schema";
|
|
3027
|
+
};
|
|
3028
|
+
/**
|
|
3029
|
+
* A session-scoped sandbox transition applied while handling a slash command
|
|
3030
|
+
*
|
|
3031
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3032
|
+
* via the `definition` "SandboxSessionChange".
|
|
3033
|
+
*/
|
|
3034
|
+
/** @experimental */
|
|
3035
|
+
export type SandboxSessionChange =
|
|
3036
|
+
/** The sandbox is off for the rest of this session; nothing was persisted and a new session starts from managed policy. */
|
|
3037
|
+
"disabled"
|
|
3038
|
+
/** A previous session-scoped opt-out was cleared and the sandbox is enforced again. */
|
|
3039
|
+
| "restored";
|
|
2963
3040
|
/**
|
|
2964
3041
|
* Current authentication information, or null when no authentication is active.
|
|
2965
3042
|
*
|
|
@@ -6956,7 +7033,7 @@ export interface CurrentToolMetadata {
|
|
|
6956
7033
|
deferLoading?: boolean;
|
|
6957
7034
|
}
|
|
6958
7035
|
/**
|
|
6959
|
-
* A file included in the
|
|
7036
|
+
* A file included in the session debug bundle.
|
|
6960
7037
|
*
|
|
6961
7038
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6962
7039
|
* via the `definition` "DebugCollectLogsCollectedEntry".
|
|
@@ -7034,7 +7111,7 @@ export interface DebugCollectLogsInclude {
|
|
|
7034
7111
|
previousProcessLogLimit?: number;
|
|
7035
7112
|
}
|
|
7036
7113
|
/**
|
|
7037
|
-
* Options for collecting a
|
|
7114
|
+
* Options for collecting a session debug bundle with configurable redaction.
|
|
7038
7115
|
*
|
|
7039
7116
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7040
7117
|
* via the `definition` "DebugCollectLogsRequest".
|
|
@@ -7049,7 +7126,7 @@ export interface DebugCollectLogsRequest {
|
|
|
7049
7126
|
additionalEntries?: DebugCollectLogsEntry[];
|
|
7050
7127
|
}
|
|
7051
7128
|
/**
|
|
7052
|
-
* Result of collecting a
|
|
7129
|
+
* Result of collecting a session debug bundle.
|
|
7053
7130
|
*
|
|
7054
7131
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7055
7132
|
* via the `definition` "DebugCollectLogsResult".
|
|
@@ -7062,7 +7139,7 @@ export interface DebugCollectLogsResult {
|
|
|
7062
7139
|
*/
|
|
7063
7140
|
path: string;
|
|
7064
7141
|
/**
|
|
7065
|
-
* Files included in the
|
|
7142
|
+
* Files included in the bundle.
|
|
7066
7143
|
*/
|
|
7067
7144
|
entries: DebugCollectLogsCollectedEntry[];
|
|
7068
7145
|
/**
|
|
@@ -9575,6 +9652,10 @@ export interface InstalledPluginInfo {
|
|
|
9575
9652
|
* Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records — a plugin belonging to a directory/local marketplace, which is loaded from its real directory on every pass instead of a copy under the installed-plugins cache. Its presence is what marks a listed plugin as live: such a plugin is always present on disk, so `enabled` is its only meaningful state and it is never "not installed".
|
|
9576
9653
|
*/
|
|
9577
9654
|
installedFrom?: string;
|
|
9655
|
+
/**
|
|
9656
|
+
* Runtime-reported plugin provenance. Currently set to "builtin" only for plugins registered through the trusted host built-in boundary; absent for installed, marketplace, direct, and live plugins.
|
|
9657
|
+
*/
|
|
9658
|
+
source?: string;
|
|
9578
9659
|
}
|
|
9579
9660
|
/**
|
|
9580
9661
|
* Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path.
|
|
@@ -9728,6 +9809,31 @@ export interface InterruptMainTurnResult {
|
|
|
9728
9809
|
*/
|
|
9729
9810
|
interrupted: boolean;
|
|
9730
9811
|
}
|
|
9812
|
+
/**
|
|
9813
|
+
* A JSON Schema output contract. OpenAI receives the name, description, schema and strict setting; Anthropic receives the schema in output_config.format and always uses its native strict enforcement.
|
|
9814
|
+
*
|
|
9815
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9816
|
+
* via the `definition` "JsonSchemaResponseFormat".
|
|
9817
|
+
*/
|
|
9818
|
+
/** @experimental */
|
|
9819
|
+
export interface JsonSchemaResponseFormat {
|
|
9820
|
+
/**
|
|
9821
|
+
* Name of the output schema, subject to the provider's naming restrictions.
|
|
9822
|
+
*/
|
|
9823
|
+
name: string;
|
|
9824
|
+
/**
|
|
9825
|
+
* JSON Schema passed unchanged to the inference provider. Schemas larger than 32 MiB when JSON-encoded are rejected before admission, using the runtime's existing request-size ceiling. This is not a guarantee that the entire model request fits. Supported keywords and schema restrictions are determined by the provider.
|
|
9826
|
+
*/
|
|
9827
|
+
schema: JsonValue;
|
|
9828
|
+
/**
|
|
9829
|
+
* Optional description passed to OpenAI providers.
|
|
9830
|
+
*/
|
|
9831
|
+
description?: string;
|
|
9832
|
+
/**
|
|
9833
|
+
* Optional strict enforcement setting for OpenAI providers. Omitted uses the provider default. Anthropic always enforces its supported schema subset.
|
|
9834
|
+
*/
|
|
9835
|
+
strict?: boolean;
|
|
9836
|
+
}
|
|
9731
9837
|
/**
|
|
9732
9838
|
* HTTP headers as a map from lowercased header name to a list of values. Multi-valued headers (e.g. Set-Cookie) preserve all values.
|
|
9733
9839
|
*
|
|
@@ -10076,6 +10182,35 @@ export interface LspInitializeRequest {
|
|
|
10076
10182
|
*/
|
|
10077
10183
|
force?: boolean;
|
|
10078
10184
|
}
|
|
10185
|
+
/**
|
|
10186
|
+
* Non-secret host-managed HTTP MCP server configuration. The containing map key is the stable managed identity; credentials are supplied dynamically by the host.
|
|
10187
|
+
*
|
|
10188
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10189
|
+
* via the `definition` "ManagedMcpServerConfig".
|
|
10190
|
+
*/
|
|
10191
|
+
/** @experimental */
|
|
10192
|
+
export interface ManagedMcpServerConfig {
|
|
10193
|
+
/**
|
|
10194
|
+
* Human-readable catalog display name.
|
|
10195
|
+
*/
|
|
10196
|
+
displayName: string;
|
|
10197
|
+
/**
|
|
10198
|
+
* Hosted MCP streamable HTTP endpoint.
|
|
10199
|
+
*/
|
|
10200
|
+
url: string;
|
|
10201
|
+
/**
|
|
10202
|
+
* Tools to include. Defaults to all tools when omitted.
|
|
10203
|
+
*/
|
|
10204
|
+
tools?: string[];
|
|
10205
|
+
/**
|
|
10206
|
+
* Timeout in milliseconds for tool discovery and tool calls.
|
|
10207
|
+
*/
|
|
10208
|
+
timeout?: number;
|
|
10209
|
+
/**
|
|
10210
|
+
* Maximum dynamic-header cache lifetime in milliseconds.
|
|
10211
|
+
*/
|
|
10212
|
+
headersRefreshTtlMs?: number;
|
|
10213
|
+
}
|
|
10079
10214
|
/**
|
|
10080
10215
|
* Validated device-managed settings discovered before a session exists.
|
|
10081
10216
|
*
|
|
@@ -12033,6 +12168,10 @@ export interface McpServer {
|
|
|
12033
12168
|
* Plugin version that provided this server, when source is plugin.
|
|
12034
12169
|
*/
|
|
12035
12170
|
sourcePluginVersion?: string;
|
|
12171
|
+
/**
|
|
12172
|
+
* Human-readable display name supplied by a managed server catalog.
|
|
12173
|
+
*/
|
|
12174
|
+
displayName?: string;
|
|
12036
12175
|
/**
|
|
12037
12176
|
* Error message if the server failed to connect
|
|
12038
12177
|
*/
|
|
@@ -15346,6 +15485,59 @@ export interface ProtocolExternalToolDefinition {
|
|
|
15346
15485
|
[k: string]: JsonValue | undefined;
|
|
15347
15486
|
};
|
|
15348
15487
|
}
|
|
15488
|
+
/** @experimental */
|
|
15489
|
+
export interface ProtocolStaticSectionOverride {
|
|
15490
|
+
action: ProtocolStaticSectionAction;
|
|
15491
|
+
/**
|
|
15492
|
+
* Optional content used by replace, append, and prepend operations.
|
|
15493
|
+
*/
|
|
15494
|
+
content?: string;
|
|
15495
|
+
}
|
|
15496
|
+
/** @experimental */
|
|
15497
|
+
export interface ProtocolSystemMessageAppendConfig {
|
|
15498
|
+
mode?: ProtocolAppendMode;
|
|
15499
|
+
/**
|
|
15500
|
+
* Text appended to the standard system prompt.
|
|
15501
|
+
*/
|
|
15502
|
+
content?: string;
|
|
15503
|
+
}
|
|
15504
|
+
/** @experimental */
|
|
15505
|
+
export interface ProtocolSystemMessageReplaceConfig {
|
|
15506
|
+
mode: ProtocolReplaceMode;
|
|
15507
|
+
/**
|
|
15508
|
+
* Complete replacement system-message text.
|
|
15509
|
+
*/
|
|
15510
|
+
content: string;
|
|
15511
|
+
/**
|
|
15512
|
+
* Optional structured blocks corresponding to the replacement content.
|
|
15513
|
+
*/
|
|
15514
|
+
contentBlocks?: SystemMessageBlock[];
|
|
15515
|
+
}
|
|
15516
|
+
/** @experimental */
|
|
15517
|
+
export interface SystemMessageBlock {
|
|
15518
|
+
/**
|
|
15519
|
+
* Text content for this system-message block.
|
|
15520
|
+
*/
|
|
15521
|
+
content: string;
|
|
15522
|
+
/**
|
|
15523
|
+
* Whether the block is static and may be cached independently of dynamic prompt content.
|
|
15524
|
+
*/
|
|
15525
|
+
isStatic?: boolean;
|
|
15526
|
+
}
|
|
15527
|
+
/** @experimental */
|
|
15528
|
+
export interface ProtocolSystemMessageCustomizeConfig {
|
|
15529
|
+
mode: ProtocolCustomizeMode;
|
|
15530
|
+
/**
|
|
15531
|
+
* Named standard-prompt section overrides.
|
|
15532
|
+
*/
|
|
15533
|
+
sections?: {
|
|
15534
|
+
[k: string]: ProtocolSectionOverride;
|
|
15535
|
+
};
|
|
15536
|
+
/**
|
|
15537
|
+
* Text appended after the customized sections.
|
|
15538
|
+
*/
|
|
15539
|
+
content?: string;
|
|
15540
|
+
}
|
|
15349
15541
|
/**
|
|
15350
15542
|
* BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both.
|
|
15351
15543
|
*
|
|
@@ -15404,6 +15596,7 @@ export interface ProviderModelConfig {
|
|
|
15404
15596
|
*/
|
|
15405
15597
|
maxOutputTokens?: number;
|
|
15406
15598
|
capabilities?: ModelCapabilitiesOverride;
|
|
15599
|
+
systemMessage?: ProtocolSystemMessageConfig;
|
|
15407
15600
|
}
|
|
15408
15601
|
/**
|
|
15409
15602
|
* The selectable model entries synthesized for the models added by this call.
|
|
@@ -16474,15 +16667,6 @@ export interface RegisterEventInterestResult {
|
|
|
16474
16667
|
*/
|
|
16475
16668
|
handle: string;
|
|
16476
16669
|
}
|
|
16477
|
-
/**
|
|
16478
|
-
* Optional registration options.
|
|
16479
|
-
*
|
|
16480
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
16481
|
-
* via the `definition` "SessionsRegisterExtensionToolsOnSessionOptions".
|
|
16482
|
-
*/
|
|
16483
|
-
/** @experimental */
|
|
16484
|
-
export interface SessionsRegisterExtensionToolsOnSessionOptions {
|
|
16485
|
-
}
|
|
16486
16670
|
/**
|
|
16487
16671
|
* Opaque handle previously returned by `registerInterest` to release.
|
|
16488
16672
|
*
|
|
@@ -16904,6 +17088,14 @@ export interface SandboxConfigUserPolicyFilesystem {
|
|
|
16904
17088
|
*/
|
|
16905
17089
|
/** @experimental */
|
|
16906
17090
|
export interface SandboxConfigUserPolicyNetwork {
|
|
17091
|
+
/**
|
|
17092
|
+
* Hosts allowed through the built-in sandbox proxy. A non-empty list denies unmatched hosts; an absent or empty list allows all hosts not blocked. Supports exact hostnames, IP addresses, and *.example.com for strict subdomains. Host rules do not override the outbound or local-network toggles.
|
|
17093
|
+
*/
|
|
17094
|
+
allowedHosts?: string[];
|
|
17095
|
+
/**
|
|
17096
|
+
* Hosts denied by the built-in sandbox proxy. Deny rules take precedence over allowedHosts. A domain also denies all its subdomains. IP addresses match exactly; *.example.com matches strict subdomains, and * denies every host.
|
|
17097
|
+
*/
|
|
17098
|
+
blockedHosts?: string[];
|
|
16907
17099
|
/**
|
|
16908
17100
|
* Whether outbound network traffic is allowed at all.
|
|
16909
17101
|
*/
|
|
@@ -17342,7 +17534,7 @@ export interface SendMessageItem {
|
|
|
17342
17534
|
/** @experimental */
|
|
17343
17535
|
export interface SendMessagesRequest {
|
|
17344
17536
|
/**
|
|
17345
|
-
* The user messages to append to the conversation, in order. May be empty, in which case a single turn runs over the existing history with no new user message.
|
|
17537
|
+
* The user messages to append to the conversation, in order, before running one agent loop. When the batch starts a run, its final message is the primary initiating message; earlier messages provide context, not separate runs or replies. May be empty, in which case a single turn runs over the existing history with no new user message or originatingMessageId.
|
|
17346
17538
|
*/
|
|
17347
17539
|
messages: SendMessageItem[];
|
|
17348
17540
|
mode?: SendMode;
|
|
@@ -17357,6 +17549,7 @@ export interface SendMessagesRequest {
|
|
|
17357
17549
|
requestHeaders?: {
|
|
17358
17550
|
[k: string]: string | undefined;
|
|
17359
17551
|
};
|
|
17552
|
+
responseFormat?: ResponseFormat;
|
|
17360
17553
|
/**
|
|
17361
17554
|
* W3C Trace Context traceparent header for distributed tracing of this agent turn
|
|
17362
17555
|
*/
|
|
@@ -17379,7 +17572,7 @@ export interface SendMessagesRequest {
|
|
|
17379
17572
|
/** @experimental */
|
|
17380
17573
|
export interface SendMessagesResult {
|
|
17381
17574
|
/**
|
|
17382
|
-
* Unique identifiers assigned to the messages, one per provided message in order. Empty when no messages were provided.
|
|
17575
|
+
* Unique identifiers assigned to the messages, one per provided message in order. For a batch that starts a run, assistant messages use the final ID as originatingMessageId throughout that run, including tool iterations and stop-hook corrections. Immediate steering does not replace the active run's origin. Empty when no messages were provided; that run has no originatingMessageId.
|
|
17383
17576
|
*/
|
|
17384
17577
|
messageIds: string[];
|
|
17385
17578
|
}
|
|
@@ -17423,6 +17616,7 @@ export interface SendRequest {
|
|
|
17423
17616
|
requestHeaders?: {
|
|
17424
17617
|
[k: string]: string | undefined;
|
|
17425
17618
|
};
|
|
17619
|
+
responseFormat?: ResponseFormat;
|
|
17426
17620
|
/**
|
|
17427
17621
|
* W3C Trace Context traceparent header for distributed tracing of this agent turn
|
|
17428
17622
|
*/
|
|
@@ -18591,7 +18785,7 @@ export interface SessionOpenOptions {
|
|
|
18591
18785
|
*/
|
|
18592
18786
|
integrationId?: string;
|
|
18593
18787
|
/**
|
|
18594
|
-
* Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap.
|
|
18788
|
+
* Opt-in: self-fetch and enforce enterprise managed settings, including managed hook policies, at session bootstrap.
|
|
18595
18789
|
*/
|
|
18596
18790
|
enableManagedSettings?: boolean;
|
|
18597
18791
|
managedSettings?: SessionManagedSettings;
|
|
@@ -18693,6 +18887,14 @@ export interface SessionOpenOptions {
|
|
|
18693
18887
|
* MCP server names disabled for this session. Disabled servers are not started or authenticated on create or cold resume.
|
|
18694
18888
|
*/
|
|
18695
18889
|
disabledMcpServers?: string[];
|
|
18890
|
+
/**
|
|
18891
|
+
* Non-secret host-managed HTTP MCP servers keyed by stable managed identity. Managed provenance is runtime-established from this separate field and credentials are supplied through dynamic-header refresh.
|
|
18892
|
+
*
|
|
18893
|
+
* @experimental
|
|
18894
|
+
*/
|
|
18895
|
+
managedMcpServers?: {
|
|
18896
|
+
[k: string]: ManagedMcpServerConfig;
|
|
18897
|
+
};
|
|
18696
18898
|
/**
|
|
18697
18899
|
* Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers.
|
|
18698
18900
|
*/
|
|
@@ -20387,6 +20589,10 @@ export interface ShutdownRequest {
|
|
|
20387
20589
|
* Optional human-readable reason. Typically the message of the error that triggered shutdown when type is 'error'.
|
|
20388
20590
|
*/
|
|
20389
20591
|
reason?: string;
|
|
20592
|
+
/**
|
|
20593
|
+
* Dispatch deferred sessionEnd hooks in the background with their full per-hook timeoutSec instead of awaiting them under the short shared shutdown budget. Set this when the host process keeps running after the session closes (for example the CLI's /clear), so a slow hook neither blocks the close nor is aborted. Hooks still detached when the process later exits are terminated with it. Defaults to false.
|
|
20594
|
+
*/
|
|
20595
|
+
detachSessionEndHooks?: boolean;
|
|
20390
20596
|
}
|
|
20391
20597
|
/**
|
|
20392
20598
|
* Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint.
|
|
@@ -20776,6 +20982,7 @@ export interface SlashCommandTextResult {
|
|
|
20776
20982
|
* True when the invocation mutated user runtime settings; consumers caching settings should refresh
|
|
20777
20983
|
*/
|
|
20778
20984
|
runtimeSettingsChanged?: boolean;
|
|
20985
|
+
sandboxSessionChange?: SandboxSessionChange;
|
|
20779
20986
|
}
|
|
20780
20987
|
/**
|
|
20781
20988
|
* Slash-command invocation result asking the client to present subcommand options for a parent command.
|
|
@@ -23042,6 +23249,23 @@ export interface WorkspacesCheckpoints {
|
|
|
23042
23249
|
*/
|
|
23043
23250
|
filename: string;
|
|
23044
23251
|
}
|
|
23252
|
+
/**
|
|
23253
|
+
* Directory to create within the session workspace files directory.
|
|
23254
|
+
*
|
|
23255
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23256
|
+
* via the `definition` "WorkspacesCreateDirectoryRequest".
|
|
23257
|
+
*/
|
|
23258
|
+
/** @experimental */
|
|
23259
|
+
export interface WorkspacesCreateDirectoryRequest {
|
|
23260
|
+
/**
|
|
23261
|
+
* Slash-separated relative path within the workspace files directory
|
|
23262
|
+
*/
|
|
23263
|
+
path: string;
|
|
23264
|
+
/**
|
|
23265
|
+
* Whether to create missing parent directories. Defaults to false.
|
|
23266
|
+
*/
|
|
23267
|
+
recursive?: boolean;
|
|
23268
|
+
}
|
|
23045
23269
|
/**
|
|
23046
23270
|
* Relative path and UTF-8 content for the workspace file to create or overwrite.
|
|
23047
23271
|
*
|
|
@@ -23051,7 +23275,7 @@ export interface WorkspacesCheckpoints {
|
|
|
23051
23275
|
/** @experimental */
|
|
23052
23276
|
export interface WorkspacesCreateFileRequest {
|
|
23053
23277
|
/**
|
|
23054
|
-
*
|
|
23278
|
+
* Slash-separated relative path within the workspace files directory
|
|
23055
23279
|
*/
|
|
23056
23280
|
path: string;
|
|
23057
23281
|
/**
|
|
@@ -23204,7 +23428,7 @@ export interface WorkspacesListCheckpointsResult {
|
|
|
23204
23428
|
/** @experimental */
|
|
23205
23429
|
export interface WorkspacesListFilesResult {
|
|
23206
23430
|
/**
|
|
23207
|
-
*
|
|
23431
|
+
* Slash-separated relative file paths in the workspace files directory
|
|
23208
23432
|
*/
|
|
23209
23433
|
files: string[];
|
|
23210
23434
|
}
|
|
@@ -23256,7 +23480,7 @@ export interface WorkspacesReadCheckpointResult {
|
|
|
23256
23480
|
/** @experimental */
|
|
23257
23481
|
export interface WorkspacesReadFileRequest {
|
|
23258
23482
|
/**
|
|
23259
|
-
*
|
|
23483
|
+
* Slash-separated relative path within the workspace files directory
|
|
23260
23484
|
*/
|
|
23261
23485
|
path: string;
|
|
23262
23486
|
}
|
|
@@ -23273,6 +23497,44 @@ export interface WorkspacesReadFileResult {
|
|
|
23273
23497
|
*/
|
|
23274
23498
|
content: string;
|
|
23275
23499
|
}
|
|
23500
|
+
/**
|
|
23501
|
+
* File or directory to remove from the session workspace files directory.
|
|
23502
|
+
*
|
|
23503
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23504
|
+
* via the `definition` "WorkspacesRemovePathRequest".
|
|
23505
|
+
*/
|
|
23506
|
+
/** @experimental */
|
|
23507
|
+
export interface WorkspacesRemovePathRequest {
|
|
23508
|
+
/**
|
|
23509
|
+
* Slash-separated relative path within the workspace files directory
|
|
23510
|
+
*/
|
|
23511
|
+
path: string;
|
|
23512
|
+
/**
|
|
23513
|
+
* Whether to remove directory contents recursively. Defaults to false.
|
|
23514
|
+
*/
|
|
23515
|
+
recursive?: boolean;
|
|
23516
|
+
/**
|
|
23517
|
+
* Whether a missing path should be treated as success. Defaults to false.
|
|
23518
|
+
*/
|
|
23519
|
+
force?: boolean;
|
|
23520
|
+
}
|
|
23521
|
+
/**
|
|
23522
|
+
* Source and destination paths for a rename within the session workspace files directory.
|
|
23523
|
+
*
|
|
23524
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23525
|
+
* via the `definition` "WorkspacesRenamePathRequest".
|
|
23526
|
+
*/
|
|
23527
|
+
/** @experimental */
|
|
23528
|
+
export interface WorkspacesRenamePathRequest {
|
|
23529
|
+
/**
|
|
23530
|
+
* Slash-separated source path relative to the workspace files directory
|
|
23531
|
+
*/
|
|
23532
|
+
source: string;
|
|
23533
|
+
/**
|
|
23534
|
+
* Slash-separated destination path relative to the workspace files directory
|
|
23535
|
+
*/
|
|
23536
|
+
destination: string;
|
|
23537
|
+
}
|
|
23276
23538
|
/**
|
|
23277
23539
|
* Pasted content to save as a UTF-8 file in the session workspace.
|
|
23278
23540
|
*
|
|
@@ -23312,6 +23574,48 @@ export interface WorkspacesSaveLargePasteResult {
|
|
|
23312
23574
|
sizeBytes: number;
|
|
23313
23575
|
} | null;
|
|
23314
23576
|
}
|
|
23577
|
+
/**
|
|
23578
|
+
* Relative path of the workspace file or directory to inspect.
|
|
23579
|
+
*
|
|
23580
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23581
|
+
* via the `definition` "WorkspacesStatFileRequest".
|
|
23582
|
+
*/
|
|
23583
|
+
/** @experimental */
|
|
23584
|
+
export interface WorkspacesStatFileRequest {
|
|
23585
|
+
/**
|
|
23586
|
+
* Slash-separated relative path within the workspace files directory
|
|
23587
|
+
*/
|
|
23588
|
+
path: string;
|
|
23589
|
+
}
|
|
23590
|
+
/**
|
|
23591
|
+
* Filesystem metadata for a path in the session workspace files directory.
|
|
23592
|
+
*
|
|
23593
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23594
|
+
* via the `definition` "WorkspacesStatFileResult".
|
|
23595
|
+
*/
|
|
23596
|
+
/** @experimental */
|
|
23597
|
+
export interface WorkspacesStatFileResult {
|
|
23598
|
+
/**
|
|
23599
|
+
* Whether the path identifies a regular file
|
|
23600
|
+
*/
|
|
23601
|
+
isFile: boolean;
|
|
23602
|
+
/**
|
|
23603
|
+
* Whether the path identifies a directory
|
|
23604
|
+
*/
|
|
23605
|
+
isDirectory: boolean;
|
|
23606
|
+
/**
|
|
23607
|
+
* Size in bytes
|
|
23608
|
+
*/
|
|
23609
|
+
size: number;
|
|
23610
|
+
/**
|
|
23611
|
+
* Last modification time in Unix epoch milliseconds
|
|
23612
|
+
*/
|
|
23613
|
+
mtimeMs: number;
|
|
23614
|
+
/**
|
|
23615
|
+
* Creation time in Unix epoch milliseconds
|
|
23616
|
+
*/
|
|
23617
|
+
birthtimeMs: number;
|
|
23618
|
+
}
|
|
23315
23619
|
/**
|
|
23316
23620
|
* Rollback point for local workspace summaries.
|
|
23317
23621
|
*
|
|
@@ -24269,11 +24573,11 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
24269
24573
|
/** @experimental */
|
|
24270
24574
|
debug: {
|
|
24271
24575
|
/**
|
|
24272
|
-
* Collects a
|
|
24576
|
+
* Collects a session debug log bundle into a local archive or staging directory. Logs are redacted by default; redaction can be configured per caller-provided diagnostic entry. The runtime includes session-owned logs by default and accepts caller-provided diagnostic entries so host applications can add their own files without changing this API shape.
|
|
24273
24577
|
*
|
|
24274
|
-
* @param params Options for collecting a
|
|
24578
|
+
* @param params Options for collecting a session debug bundle with configurable redaction.
|
|
24275
24579
|
*
|
|
24276
|
-
* @returns Result of collecting a
|
|
24580
|
+
* @returns Result of collecting a session debug bundle.
|
|
24277
24581
|
*/
|
|
24278
24582
|
collectLogs: (params: DebugCollectLogsRequest) => Promise<DebugCollectLogsResult>;
|
|
24279
24583
|
};
|
|
@@ -24583,6 +24887,32 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
24583
24887
|
* @param params Relative path and UTF-8 content for the workspace file to create or overwrite.
|
|
24584
24888
|
*/
|
|
24585
24889
|
createFile: (params: WorkspacesCreateFileRequest) => Promise<void>;
|
|
24890
|
+
/**
|
|
24891
|
+
* Returns metadata for a file or directory in the session workspace files directory.
|
|
24892
|
+
*
|
|
24893
|
+
* @param params Relative path of the workspace file or directory to inspect.
|
|
24894
|
+
*
|
|
24895
|
+
* @returns Filesystem metadata for a path in the session workspace files directory.
|
|
24896
|
+
*/
|
|
24897
|
+
statFile: (params: WorkspacesStatFileRequest) => Promise<WorkspacesStatFileResult>;
|
|
24898
|
+
/**
|
|
24899
|
+
* Creates a directory in the session workspace files directory.
|
|
24900
|
+
*
|
|
24901
|
+
* @param params Directory to create within the session workspace files directory.
|
|
24902
|
+
*/
|
|
24903
|
+
createDirectory: (params: WorkspacesCreateDirectoryRequest) => Promise<void>;
|
|
24904
|
+
/**
|
|
24905
|
+
* Removes a file or directory from the session workspace files directory.
|
|
24906
|
+
*
|
|
24907
|
+
* @param params File or directory to remove from the session workspace files directory.
|
|
24908
|
+
*/
|
|
24909
|
+
removePath: (params: WorkspacesRemovePathRequest) => Promise<void>;
|
|
24910
|
+
/**
|
|
24911
|
+
* Renames a file or directory within the session workspace files directory.
|
|
24912
|
+
*
|
|
24913
|
+
* @param params Source and destination paths for a rename within the session workspace files directory.
|
|
24914
|
+
*/
|
|
24915
|
+
renamePath: (params: WorkspacesRenamePathRequest) => Promise<void>;
|
|
24586
24916
|
/**
|
|
24587
24917
|
* Lists workspace checkpoints in chronological order.
|
|
24588
24918
|
*
|