@github/copilot-sdk 1.0.6-preview.1 → 1.0.7-preview.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/dist/cjs/client.js +9 -5
- package/dist/cjs/generated/rpc.js +64 -28
- package/dist/client.js +9 -5
- package/dist/generated/rpc.d.ts +893 -155
- package/dist/generated/rpc.js +64 -28
- package/dist/generated/session-events.d.ts +373 -84
- package/dist/types.d.ts +7 -0
- package/package.json +2 -2
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, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval } from "./session-events.js";
|
|
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
7
|
/**
|
|
8
8
|
* Initial authentication info for the session.
|
|
9
9
|
*
|
|
@@ -188,6 +188,20 @@ export type AgentRegistrySpawnValidationErrorField =
|
|
|
188
188
|
| "model"
|
|
189
189
|
/** The permissionMode parameter */
|
|
190
190
|
| "permissionMode";
|
|
191
|
+
/**
|
|
192
|
+
* Current or requested allow-all mode.
|
|
193
|
+
*
|
|
194
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
195
|
+
* via the `definition` "PermissionsAllowAllMode".
|
|
196
|
+
*/
|
|
197
|
+
/** @experimental */
|
|
198
|
+
export type PermissionsAllowAllMode =
|
|
199
|
+
/** Permission requests follow the normal approval flow. */
|
|
200
|
+
"off"
|
|
201
|
+
/** Tool, path, and URL permission requests are automatically approved. */
|
|
202
|
+
| "on"
|
|
203
|
+
/** Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. */
|
|
204
|
+
| "auto";
|
|
191
205
|
/**
|
|
192
206
|
* Authentication type
|
|
193
207
|
*
|
|
@@ -266,6 +280,82 @@ export type ContentFilterMode =
|
|
|
266
280
|
| "markdown"
|
|
267
281
|
/** Remove characters that can hide directives. */
|
|
268
282
|
| "hidden_characters";
|
|
283
|
+
/**
|
|
284
|
+
* Source category for a collected debug bundle entry.
|
|
285
|
+
*
|
|
286
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
287
|
+
* via the `definition` "DebugCollectLogsSource".
|
|
288
|
+
*/
|
|
289
|
+
/** @experimental */
|
|
290
|
+
export type DebugCollectLogsSource =
|
|
291
|
+
/** Session event log. */
|
|
292
|
+
"events"
|
|
293
|
+
/** Process log for the session. */
|
|
294
|
+
| "process-log"
|
|
295
|
+
/** Interactive shell log for the session. */
|
|
296
|
+
| "shell-log"
|
|
297
|
+
/** Caller-provided diagnostic entry. */
|
|
298
|
+
| "additional";
|
|
299
|
+
/**
|
|
300
|
+
* Destination for the redacted debug bundle.
|
|
301
|
+
*
|
|
302
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
303
|
+
* via the `definition` "DebugCollectLogsDestination".
|
|
304
|
+
*/
|
|
305
|
+
/** @experimental */
|
|
306
|
+
export type DebugCollectLogsDestination = {
|
|
307
|
+
/**
|
|
308
|
+
* Absolute or server-relative path for the .tgz archive to create.
|
|
309
|
+
*/
|
|
310
|
+
outputPath: string;
|
|
311
|
+
/**
|
|
312
|
+
* When true, create the archive atomically without overwriting an existing file by appending ` (N)` before the extension as needed. Defaults to false.
|
|
313
|
+
*/
|
|
314
|
+
noOverwrite?: boolean;
|
|
315
|
+
kind: "archive";
|
|
316
|
+
} | {
|
|
317
|
+
/**
|
|
318
|
+
* Directory where redacted files should be staged. The directory is created if needed.
|
|
319
|
+
*/
|
|
320
|
+
outputDirectory: string;
|
|
321
|
+
kind: "directory";
|
|
322
|
+
};
|
|
323
|
+
/**
|
|
324
|
+
* Kind of caller-provided debug log entry.
|
|
325
|
+
*
|
|
326
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
327
|
+
* via the `definition` "DebugCollectLogsEntryKind".
|
|
328
|
+
*/
|
|
329
|
+
/** @experimental */
|
|
330
|
+
export type DebugCollectLogsEntryKind =
|
|
331
|
+
/** Include a single server-local file. */
|
|
332
|
+
"file"
|
|
333
|
+
/** Include files from a server-local directory recursively. */
|
|
334
|
+
| "directory";
|
|
335
|
+
/**
|
|
336
|
+
* How a collected debug entry should be redacted before being staged.
|
|
337
|
+
*
|
|
338
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
339
|
+
* via the `definition` "DebugCollectLogsRedaction".
|
|
340
|
+
*/
|
|
341
|
+
/** @experimental */
|
|
342
|
+
export type DebugCollectLogsRedaction =
|
|
343
|
+
/** Redact the file as plain UTF-8 log text. */
|
|
344
|
+
"plain-text"
|
|
345
|
+
/** Redact each non-empty line as a session event JSON object, falling back to plain-text redaction for malformed lines. */
|
|
346
|
+
| "events-jsonl";
|
|
347
|
+
/**
|
|
348
|
+
* Destination kind that was written.
|
|
349
|
+
*
|
|
350
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
351
|
+
* via the `definition` "DebugCollectLogsResultKind".
|
|
352
|
+
*/
|
|
353
|
+
/** @experimental */
|
|
354
|
+
export type DebugCollectLogsResultKind =
|
|
355
|
+
/** A .tgz archive was written. */
|
|
356
|
+
"archive"
|
|
357
|
+
/** A directory containing redacted files was written. */
|
|
358
|
+
| "directory";
|
|
269
359
|
/**
|
|
270
360
|
* Server transport type: stdio, http, sse (deprecated), or memory
|
|
271
361
|
*
|
|
@@ -1179,7 +1269,7 @@ export type ProviderEndpointTransport =
|
|
|
1179
1269
|
/** WebSocket transport. */
|
|
1180
1270
|
| "websockets";
|
|
1181
1271
|
/**
|
|
1182
|
-
*
|
|
1272
|
+
* Attachment union accepted by push input, covering files, directories, GitHub objects, blobs, snippets, and extension context.
|
|
1183
1273
|
*
|
|
1184
1274
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1185
1275
|
* via the `definition` "PushAttachment".
|
|
@@ -1536,6 +1626,52 @@ export type SessionsOpenProgressStatus =
|
|
|
1536
1626
|
"in-progress"
|
|
1537
1627
|
/** The step has completed successfully. */
|
|
1538
1628
|
| "complete";
|
|
1629
|
+
/**
|
|
1630
|
+
* Rust-owned settings predicates exposed across the SDK boundary. Raw feature-flag names are intentionally not part of the contract.
|
|
1631
|
+
*
|
|
1632
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1633
|
+
* via the `definition` "SessionSettingsPredicateName".
|
|
1634
|
+
*/
|
|
1635
|
+
/** @experimental */
|
|
1636
|
+
export type SessionSettingsPredicateName =
|
|
1637
|
+
/** Whether the security-tools feature flag enables security tool wiring. */
|
|
1638
|
+
"securityToolsEnabled"
|
|
1639
|
+
/** Whether third-party security tools should receive the security prompt. */
|
|
1640
|
+
| "thirdPartySecurityPromptEnabled"
|
|
1641
|
+
/** Whether validation may run in parallel. */
|
|
1642
|
+
| "parallelValidationEnabled"
|
|
1643
|
+
/** Whether runtime timing telemetry is enabled. */
|
|
1644
|
+
| "runtimeTimingTelemetryEnabled"
|
|
1645
|
+
/** Whether the co-author hook is enabled. */
|
|
1646
|
+
| "coAuthorHookEnabled"
|
|
1647
|
+
/** Whether Chronicle integration is enabled. */
|
|
1648
|
+
| "chronicleEnabled"
|
|
1649
|
+
/** Whether content-exclusion policy may self-fetch data. */
|
|
1650
|
+
| "contentExclusionSelfFetchEnabled"
|
|
1651
|
+
/** Whether Claude Opus token-limit caps should be applied. */
|
|
1652
|
+
| "capClaudeOpusTokenLimitsEnabled"
|
|
1653
|
+
/** Whether code-review behavior is enabled. */
|
|
1654
|
+
| "codeReviewFeatureEnabled"
|
|
1655
|
+
/** Whether CCA should use the TypeScript autofind behavior. */
|
|
1656
|
+
| "ccaUseTsAutofindEnabled"
|
|
1657
|
+
/** Whether the dependency checker is enabled. */
|
|
1658
|
+
| "dependencyCheckerEnabled"
|
|
1659
|
+
/** Whether the Dependabot checker is enabled. */
|
|
1660
|
+
| "dependabotCheckerEnabled"
|
|
1661
|
+
/** Whether the CodeQL checker is enabled. */
|
|
1662
|
+
| "codeqlCheckerEnabled"
|
|
1663
|
+
/** Whether trivial-change handling is enabled. */
|
|
1664
|
+
| "trivialChangeEnabled"
|
|
1665
|
+
/** Whether trivial-change skip behavior is enabled. */
|
|
1666
|
+
| "trivialChangeSkipEnabled"
|
|
1667
|
+
/** Whether trivial-change handling is enabled for code review. */
|
|
1668
|
+
| "trivialChangeEnabledForCodeReview"
|
|
1669
|
+
/** Whether trivial-change skip behavior is enabled for code review. */
|
|
1670
|
+
| "trivialChangeSkipEnabledForCodeReview"
|
|
1671
|
+
/** Whether trivial-change handling is enabled for a specific tool. */
|
|
1672
|
+
| "trivialChangeEnabledForTool"
|
|
1673
|
+
/** Whether trivial-change skip behavior is enabled for a specific tool. */
|
|
1674
|
+
| "trivialChangeSkipEnabledForTool";
|
|
1539
1675
|
/**
|
|
1540
1676
|
* Which session sources to include. Defaults to `local` for backward compatibility.
|
|
1541
1677
|
*
|
|
@@ -1672,7 +1808,7 @@ export type TaskExecutionMode =
|
|
|
1672
1808
|
/** The task is managed in the background. */
|
|
1673
1809
|
| "background";
|
|
1674
1810
|
/**
|
|
1675
|
-
*
|
|
1811
|
+
* Tracked task union returned by task APIs, containing either an agent task or a shell task.
|
|
1676
1812
|
*
|
|
1677
1813
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1678
1814
|
* via the `definition` "TaskInfo".
|
|
@@ -1714,7 +1850,7 @@ export type UIAutoModeSwitchResponse =
|
|
|
1714
1850
|
/** Decline the automatic mode switch. */
|
|
1715
1851
|
| "no";
|
|
1716
1852
|
/**
|
|
1717
|
-
*
|
|
1853
|
+
* Submitted UI elicitation field value: string, number, boolean, or an array of strings.
|
|
1718
1854
|
*
|
|
1719
1855
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1720
1856
|
* via the `definition` "UIElicitationFieldValue".
|
|
@@ -1881,7 +2017,7 @@ export interface AbortResult {
|
|
|
1881
2017
|
error?: string;
|
|
1882
2018
|
}
|
|
1883
2019
|
/**
|
|
1884
|
-
*
|
|
2020
|
+
* Authenticated account entry returned by `account.getAllUsers`, with auth info and an optional associated token.
|
|
1885
2021
|
*
|
|
1886
2022
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1887
2023
|
* via the `definition` "AccountAllUsers".
|
|
@@ -1895,7 +2031,7 @@ export interface AccountAllUsers {
|
|
|
1895
2031
|
token?: string;
|
|
1896
2032
|
}
|
|
1897
2033
|
/**
|
|
1898
|
-
*
|
|
2034
|
+
* Authentication-info variant for GitHub-internal HMAC auth, carrying the public GitHub host and HMAC secret.
|
|
1899
2035
|
*
|
|
1900
2036
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1901
2037
|
* via the `definition` "HMACAuthInfo".
|
|
@@ -1924,18 +2060,48 @@ export interface HMACAuthInfo {
|
|
|
1924
2060
|
*/
|
|
1925
2061
|
/** @experimental */
|
|
1926
2062
|
export interface CopilotUserResponse {
|
|
2063
|
+
/**
|
|
2064
|
+
* GitHub login of the authenticated user.
|
|
2065
|
+
*/
|
|
1927
2066
|
login?: string;
|
|
2067
|
+
/**
|
|
2068
|
+
* Copilot access SKU identifier (e.g. `free_limited_copilot`, `copilot_for_business_seat_quota`) used to gate model and feature access.
|
|
2069
|
+
*/
|
|
1928
2070
|
access_type_sku?: string;
|
|
2071
|
+
/**
|
|
2072
|
+
* Opaque analytics tracking identifier for the user, forwarded from the Copilot API.
|
|
2073
|
+
*/
|
|
1929
2074
|
analytics_tracking_id?: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* Date the Copilot seat was assigned to the user, if applicable.
|
|
2077
|
+
*/
|
|
1930
2078
|
assigned_date?: ({
|
|
1931
2079
|
[k: string]: unknown | undefined;
|
|
1932
2080
|
} | string) | null;
|
|
2081
|
+
/**
|
|
2082
|
+
* Whether the user is eligible to sign up for the free/limited Copilot tier.
|
|
2083
|
+
*/
|
|
1933
2084
|
can_signup_for_limited?: boolean;
|
|
2085
|
+
/**
|
|
2086
|
+
* Whether Copilot chat is enabled for the user.
|
|
2087
|
+
*/
|
|
1934
2088
|
chat_enabled?: boolean;
|
|
2089
|
+
/**
|
|
2090
|
+
* Copilot plan name for the user (e.g. `individual`, `business`, `enterprise`).
|
|
2091
|
+
*/
|
|
1935
2092
|
copilot_plan?: string;
|
|
2093
|
+
/**
|
|
2094
|
+
* Whether `.copilotignore` content-exclusion support is enabled for the user.
|
|
2095
|
+
*/
|
|
1936
2096
|
copilotignore_enabled?: boolean;
|
|
1937
2097
|
endpoints?: CopilotUserResponseEndpoints;
|
|
2098
|
+
/**
|
|
2099
|
+
* Logins of the organizations the user belongs to.
|
|
2100
|
+
*/
|
|
1938
2101
|
organization_login_list?: string[];
|
|
2102
|
+
/**
|
|
2103
|
+
* Organizations the user belongs to, each with an optional login and display name.
|
|
2104
|
+
*/
|
|
1939
2105
|
organization_list?: ({
|
|
1940
2106
|
[k: string]: unknown | undefined;
|
|
1941
2107
|
} | ({
|
|
@@ -1946,30 +2112,72 @@ export interface CopilotUserResponse {
|
|
|
1946
2112
|
[k: string]: unknown | undefined;
|
|
1947
2113
|
} | string) | null;
|
|
1948
2114
|
} | null)[]) | null;
|
|
2115
|
+
/**
|
|
2116
|
+
* Whether the Codex agent is enabled for the user.
|
|
2117
|
+
*/
|
|
1949
2118
|
codex_agent_enabled?: boolean;
|
|
2119
|
+
/**
|
|
2120
|
+
* Whether MCP (Model Context Protocol) support is enabled for the user.
|
|
2121
|
+
*/
|
|
1950
2122
|
is_mcp_enabled?: ({
|
|
1951
2123
|
[k: string]: unknown | undefined;
|
|
1952
2124
|
} | boolean) | null;
|
|
2125
|
+
/**
|
|
2126
|
+
* Date the user's usage quota next resets, as a raw string from the Copilot API; see `quota_reset_date_utc` for the UTC-normalized value.
|
|
2127
|
+
*/
|
|
1953
2128
|
quota_reset_date?: string;
|
|
1954
2129
|
quota_snapshots?: CopilotUserResponseQuotaSnapshots;
|
|
2130
|
+
/**
|
|
2131
|
+
* Whether the user's telemetry is subject to restricted-data handling.
|
|
2132
|
+
*/
|
|
1955
2133
|
restricted_telemetry?: boolean;
|
|
2134
|
+
/**
|
|
2135
|
+
* Whether the user is a GitHub/Microsoft staff member.
|
|
2136
|
+
*/
|
|
1956
2137
|
is_staff?: boolean;
|
|
2138
|
+
/**
|
|
2139
|
+
* Raw passthrough of the Copilot API `te` flag for the user (an opaque server-side eligibility signal surfaced in telemetry); not otherwise interpreted by the runtime.
|
|
2140
|
+
*/
|
|
1957
2141
|
te?: boolean;
|
|
2142
|
+
/**
|
|
2143
|
+
* Whether the account is on usage-based (token/AI-credit) billing rather than a fixed premium-request quota.
|
|
2144
|
+
*/
|
|
1958
2145
|
token_based_billing?: boolean;
|
|
2146
|
+
/**
|
|
2147
|
+
* Whether the user is able to upgrade their Copilot plan.
|
|
2148
|
+
*/
|
|
1959
2149
|
can_upgrade_plan?: boolean;
|
|
2150
|
+
/**
|
|
2151
|
+
* UTC-normalized form of `quota_reset_date` (the date the user's usage quota next resets).
|
|
2152
|
+
*/
|
|
1960
2153
|
quota_reset_date_utc?: string;
|
|
2154
|
+
/**
|
|
2155
|
+
* Per-category quota allotments for free/limited-tier users, keyed by quota category.
|
|
2156
|
+
*/
|
|
1961
2157
|
limited_user_quotas?: {
|
|
1962
2158
|
[k: string]: number | undefined;
|
|
1963
2159
|
};
|
|
2160
|
+
/**
|
|
2161
|
+
* Date the free/limited-tier user's quotas next reset, as a raw string from the Copilot API.
|
|
2162
|
+
*/
|
|
1964
2163
|
limited_user_reset_date?: string;
|
|
2164
|
+
/**
|
|
2165
|
+
* Per-category monthly quota allotments, keyed by quota category.
|
|
2166
|
+
*/
|
|
1965
2167
|
monthly_quotas?: {
|
|
1966
2168
|
[k: string]: number | undefined;
|
|
1967
2169
|
};
|
|
2170
|
+
/**
|
|
2171
|
+
* Whether cloud session storage is enabled for the user.
|
|
2172
|
+
*/
|
|
1968
2173
|
cloud_session_storage_enabled?: boolean;
|
|
2174
|
+
/**
|
|
2175
|
+
* Whether CLI remote control is enabled for the user.
|
|
2176
|
+
*/
|
|
1969
2177
|
cli_remote_control_enabled?: boolean;
|
|
1970
2178
|
}
|
|
1971
2179
|
/**
|
|
1972
|
-
*
|
|
2180
|
+
* Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough.
|
|
1973
2181
|
*
|
|
1974
2182
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1975
2183
|
* via the `definition` "CopilotUserResponseEndpoints".
|
|
@@ -1982,7 +2190,7 @@ export interface CopilotUserResponseEndpoints {
|
|
|
1982
2190
|
telemetry?: string;
|
|
1983
2191
|
}
|
|
1984
2192
|
/**
|
|
1985
|
-
*
|
|
2193
|
+
* Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries.
|
|
1986
2194
|
*
|
|
1987
2195
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1988
2196
|
* via the `definition` "CopilotUserResponseQuotaSnapshots".
|
|
@@ -2008,70 +2216,178 @@ export interface CopilotUserResponseQuotaSnapshots {
|
|
|
2008
2216
|
} | null) | undefined;
|
|
2009
2217
|
}
|
|
2010
2218
|
/**
|
|
2011
|
-
*
|
|
2219
|
+
* Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields.
|
|
2012
2220
|
*
|
|
2013
2221
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2014
2222
|
* via the `definition` "CopilotUserResponseQuotaSnapshotsChat".
|
|
2015
2223
|
*/
|
|
2016
2224
|
/** @experimental */
|
|
2017
2225
|
export interface CopilotUserResponseQuotaSnapshotsChat {
|
|
2226
|
+
/**
|
|
2227
|
+
* Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement.
|
|
2228
|
+
*/
|
|
2018
2229
|
entitlement?: number;
|
|
2230
|
+
/**
|
|
2231
|
+
* Count of additional pay-per-request usage consumed this period beyond the entitlement.
|
|
2232
|
+
*/
|
|
2019
2233
|
overage_count?: number;
|
|
2234
|
+
/**
|
|
2235
|
+
* Whether usage may continue at pay-per-request rates once the entitlement is exhausted.
|
|
2236
|
+
*/
|
|
2020
2237
|
overage_permitted?: boolean;
|
|
2238
|
+
/**
|
|
2239
|
+
* Percentage of the entitlement remaining at the snapshot timestamp.
|
|
2240
|
+
*/
|
|
2021
2241
|
percent_remaining?: number;
|
|
2242
|
+
/**
|
|
2243
|
+
* Identifier of the quota bucket this snapshot describes.
|
|
2244
|
+
*/
|
|
2022
2245
|
quota_id?: string;
|
|
2246
|
+
/**
|
|
2247
|
+
* Amount of quota remaining at the snapshot timestamp.
|
|
2248
|
+
*/
|
|
2023
2249
|
quota_remaining?: number;
|
|
2250
|
+
/**
|
|
2251
|
+
* Remaining entitlement/quota amount at the snapshot timestamp.
|
|
2252
|
+
*/
|
|
2024
2253
|
remaining?: number;
|
|
2254
|
+
/**
|
|
2255
|
+
* Whether the entitlement for this category is unlimited.
|
|
2256
|
+
*/
|
|
2025
2257
|
unlimited?: boolean;
|
|
2258
|
+
/**
|
|
2259
|
+
* UTC timestamp when this snapshot was captured.
|
|
2260
|
+
*/
|
|
2026
2261
|
timestamp_utc?: string;
|
|
2262
|
+
/**
|
|
2263
|
+
* Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets.
|
|
2264
|
+
*/
|
|
2027
2265
|
has_quota?: boolean;
|
|
2266
|
+
/**
|
|
2267
|
+
* Unix epoch time, in seconds, when this quota next resets.
|
|
2268
|
+
*/
|
|
2028
2269
|
quota_reset_at?: number;
|
|
2270
|
+
/**
|
|
2271
|
+
* Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count.
|
|
2272
|
+
*/
|
|
2029
2273
|
token_based_billing?: boolean;
|
|
2030
2274
|
}
|
|
2031
2275
|
/**
|
|
2032
|
-
*
|
|
2276
|
+
* Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields.
|
|
2033
2277
|
*
|
|
2034
2278
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2035
2279
|
* via the `definition` "CopilotUserResponseQuotaSnapshotsCompletions".
|
|
2036
2280
|
*/
|
|
2037
2281
|
/** @experimental */
|
|
2038
2282
|
export interface CopilotUserResponseQuotaSnapshotsCompletions {
|
|
2283
|
+
/**
|
|
2284
|
+
* Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement.
|
|
2285
|
+
*/
|
|
2039
2286
|
entitlement?: number;
|
|
2287
|
+
/**
|
|
2288
|
+
* Count of additional pay-per-request usage consumed this period beyond the entitlement.
|
|
2289
|
+
*/
|
|
2040
2290
|
overage_count?: number;
|
|
2291
|
+
/**
|
|
2292
|
+
* Whether usage may continue at pay-per-request rates once the entitlement is exhausted.
|
|
2293
|
+
*/
|
|
2041
2294
|
overage_permitted?: boolean;
|
|
2295
|
+
/**
|
|
2296
|
+
* Percentage of the entitlement remaining at the snapshot timestamp.
|
|
2297
|
+
*/
|
|
2042
2298
|
percent_remaining?: number;
|
|
2299
|
+
/**
|
|
2300
|
+
* Identifier of the quota bucket this snapshot describes.
|
|
2301
|
+
*/
|
|
2043
2302
|
quota_id?: string;
|
|
2303
|
+
/**
|
|
2304
|
+
* Amount of quota remaining at the snapshot timestamp.
|
|
2305
|
+
*/
|
|
2044
2306
|
quota_remaining?: number;
|
|
2307
|
+
/**
|
|
2308
|
+
* Remaining entitlement/quota amount at the snapshot timestamp.
|
|
2309
|
+
*/
|
|
2045
2310
|
remaining?: number;
|
|
2311
|
+
/**
|
|
2312
|
+
* Whether the entitlement for this category is unlimited.
|
|
2313
|
+
*/
|
|
2046
2314
|
unlimited?: boolean;
|
|
2315
|
+
/**
|
|
2316
|
+
* UTC timestamp when this snapshot was captured.
|
|
2317
|
+
*/
|
|
2047
2318
|
timestamp_utc?: string;
|
|
2319
|
+
/**
|
|
2320
|
+
* Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets.
|
|
2321
|
+
*/
|
|
2048
2322
|
has_quota?: boolean;
|
|
2323
|
+
/**
|
|
2324
|
+
* Unix epoch time, in seconds, when this quota next resets.
|
|
2325
|
+
*/
|
|
2049
2326
|
quota_reset_at?: number;
|
|
2327
|
+
/**
|
|
2328
|
+
* Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count.
|
|
2329
|
+
*/
|
|
2050
2330
|
token_based_billing?: boolean;
|
|
2051
2331
|
}
|
|
2052
2332
|
/**
|
|
2053
|
-
*
|
|
2333
|
+
* Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields.
|
|
2054
2334
|
*
|
|
2055
2335
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2056
2336
|
* via the `definition` "CopilotUserResponseQuotaSnapshotsPremiumInteractions".
|
|
2057
2337
|
*/
|
|
2058
2338
|
/** @experimental */
|
|
2059
2339
|
export interface CopilotUserResponseQuotaSnapshotsPremiumInteractions {
|
|
2340
|
+
/**
|
|
2341
|
+
* Number of requests/units included in the entitlement for this period; `-1` denotes an unlimited entitlement.
|
|
2342
|
+
*/
|
|
2060
2343
|
entitlement?: number;
|
|
2344
|
+
/**
|
|
2345
|
+
* Count of additional pay-per-request usage consumed this period beyond the entitlement.
|
|
2346
|
+
*/
|
|
2061
2347
|
overage_count?: number;
|
|
2348
|
+
/**
|
|
2349
|
+
* Whether usage may continue at pay-per-request rates once the entitlement is exhausted.
|
|
2350
|
+
*/
|
|
2062
2351
|
overage_permitted?: boolean;
|
|
2352
|
+
/**
|
|
2353
|
+
* Percentage of the entitlement remaining at the snapshot timestamp.
|
|
2354
|
+
*/
|
|
2063
2355
|
percent_remaining?: number;
|
|
2356
|
+
/**
|
|
2357
|
+
* Identifier of the quota bucket this snapshot describes.
|
|
2358
|
+
*/
|
|
2064
2359
|
quota_id?: string;
|
|
2360
|
+
/**
|
|
2361
|
+
* Amount of quota remaining at the snapshot timestamp.
|
|
2362
|
+
*/
|
|
2065
2363
|
quota_remaining?: number;
|
|
2364
|
+
/**
|
|
2365
|
+
* Remaining entitlement/quota amount at the snapshot timestamp.
|
|
2366
|
+
*/
|
|
2066
2367
|
remaining?: number;
|
|
2368
|
+
/**
|
|
2369
|
+
* Whether the entitlement for this category is unlimited.
|
|
2370
|
+
*/
|
|
2067
2371
|
unlimited?: boolean;
|
|
2372
|
+
/**
|
|
2373
|
+
* UTC timestamp when this snapshot was captured.
|
|
2374
|
+
*/
|
|
2068
2375
|
timestamp_utc?: string;
|
|
2376
|
+
/**
|
|
2377
|
+
* Whether the user currently has quota available; when `false` and not unlimited, further requests are blocked until the quota resets.
|
|
2378
|
+
*/
|
|
2069
2379
|
has_quota?: boolean;
|
|
2380
|
+
/**
|
|
2381
|
+
* Unix epoch time, in seconds, when this quota next resets.
|
|
2382
|
+
*/
|
|
2070
2383
|
quota_reset_at?: number;
|
|
2384
|
+
/**
|
|
2385
|
+
* Whether this category uses usage-based (token/AI-credit) billing rather than a fixed premium-request count.
|
|
2386
|
+
*/
|
|
2071
2387
|
token_based_billing?: boolean;
|
|
2072
2388
|
}
|
|
2073
2389
|
/**
|
|
2074
|
-
*
|
|
2390
|
+
* Authentication-info variant for a token sourced from an environment variable, with host, optional login, token, and env var name.
|
|
2075
2391
|
*
|
|
2076
2392
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2077
2393
|
* via the `definition` "EnvAuthInfo".
|
|
@@ -2101,7 +2417,7 @@ export interface EnvAuthInfo {
|
|
|
2101
2417
|
copilotUser?: CopilotUserResponse;
|
|
2102
2418
|
}
|
|
2103
2419
|
/**
|
|
2104
|
-
*
|
|
2420
|
+
* Authentication-info variant for SDK-configured token authentication, carrying host and the secret token value.
|
|
2105
2421
|
*
|
|
2106
2422
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2107
2423
|
* via the `definition` "TokenAuthInfo".
|
|
@@ -2123,7 +2439,7 @@ export interface TokenAuthInfo {
|
|
|
2123
2439
|
copilotUser?: CopilotUserResponse;
|
|
2124
2440
|
}
|
|
2125
2441
|
/**
|
|
2126
|
-
*
|
|
2442
|
+
* Authentication-info variant for direct Copilot API token auth sourced from environment variables, with public GitHub host.
|
|
2127
2443
|
*
|
|
2128
2444
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2129
2445
|
* via the `definition` "CopilotApiTokenAuthInfo".
|
|
@@ -2141,7 +2457,7 @@ export interface CopilotApiTokenAuthInfo {
|
|
|
2141
2457
|
copilotUser?: CopilotUserResponse;
|
|
2142
2458
|
}
|
|
2143
2459
|
/**
|
|
2144
|
-
*
|
|
2460
|
+
* Authentication-info variant for OAuth user auth, with host and login; the token remains in the runtime secret store.
|
|
2145
2461
|
*
|
|
2146
2462
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2147
2463
|
* via the `definition` "UserAuthInfo".
|
|
@@ -2163,7 +2479,7 @@ export interface UserAuthInfo {
|
|
|
2163
2479
|
copilotUser?: CopilotUserResponse;
|
|
2164
2480
|
}
|
|
2165
2481
|
/**
|
|
2166
|
-
*
|
|
2482
|
+
* Authentication-info variant for GitHub CLI credentials, carrying host, login, and the `gh auth token` value.
|
|
2167
2483
|
*
|
|
2168
2484
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2169
2485
|
* via the `definition` "GhCliAuthInfo".
|
|
@@ -2189,7 +2505,7 @@ export interface GhCliAuthInfo {
|
|
|
2189
2505
|
copilotUser?: CopilotUserResponse;
|
|
2190
2506
|
}
|
|
2191
2507
|
/**
|
|
2192
|
-
*
|
|
2508
|
+
* Authentication-info variant for API-key authentication to a non-GitHub LLM provider, carrying the secret `apiKey` and host.
|
|
2193
2509
|
*
|
|
2194
2510
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2195
2511
|
* via the `definition` "ApiKeyAuthInfo".
|
|
@@ -2247,7 +2563,7 @@ export interface AccountGetQuotaResult {
|
|
|
2247
2563
|
};
|
|
2248
2564
|
}
|
|
2249
2565
|
/**
|
|
2250
|
-
*
|
|
2566
|
+
* Quota usage snapshot for a Copilot quota type, including entitlement, used requests, overage, reset date, and remaining percentage.
|
|
2251
2567
|
*
|
|
2252
2568
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2253
2569
|
* via the `definition` "AccountQuotaSnapshot".
|
|
@@ -2345,7 +2661,7 @@ export interface AccountLogoutResult {
|
|
|
2345
2661
|
hasMoreUsers: boolean;
|
|
2346
2662
|
}
|
|
2347
2663
|
/**
|
|
2348
|
-
*
|
|
2664
|
+
* Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path.
|
|
2349
2665
|
*
|
|
2350
2666
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2351
2667
|
* via the `definition` "AgentDiscoveryPath".
|
|
@@ -2393,7 +2709,7 @@ export interface AgentGetCurrentResult {
|
|
|
2393
2709
|
agent?: AgentInfo | null;
|
|
2394
2710
|
}
|
|
2395
2711
|
/**
|
|
2396
|
-
*
|
|
2712
|
+
* Custom agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path.
|
|
2397
2713
|
*
|
|
2398
2714
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2399
2715
|
* via the `definition` "AgentInfo".
|
|
@@ -2740,12 +3056,13 @@ export interface AllowAllPermissionSetResult {
|
|
|
2740
3056
|
*/
|
|
2741
3057
|
success: boolean;
|
|
2742
3058
|
/**
|
|
2743
|
-
* Authoritative allow-all state after the mutation
|
|
3059
|
+
* Authoritative full allow-all state after the mutation
|
|
2744
3060
|
*/
|
|
2745
3061
|
enabled: boolean;
|
|
3062
|
+
mode?: PermissionsAllowAllMode;
|
|
2746
3063
|
}
|
|
2747
3064
|
/**
|
|
2748
|
-
* Current
|
|
3065
|
+
* Current allow-all permission mode.
|
|
2749
3066
|
*
|
|
2750
3067
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2751
3068
|
* via the `definition` "AllowAllPermissionState".
|
|
@@ -2756,6 +3073,7 @@ export interface AllowAllPermissionState {
|
|
|
2756
3073
|
* Whether full allow-all permissions are currently active
|
|
2757
3074
|
*/
|
|
2758
3075
|
enabled: boolean;
|
|
3076
|
+
mode?: PermissionsAllowAllMode;
|
|
2759
3077
|
}
|
|
2760
3078
|
/**
|
|
2761
3079
|
* Cancellation result for a user-requested shell command.
|
|
@@ -3155,7 +3473,7 @@ export interface CommandList {
|
|
|
3155
3473
|
commands: SlashCommandInfo[];
|
|
3156
3474
|
}
|
|
3157
3475
|
/**
|
|
3158
|
-
*
|
|
3476
|
+
* Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability.
|
|
3159
3477
|
*
|
|
3160
3478
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3161
3479
|
* via the `definition` "SlashCommandInfo".
|
|
@@ -3315,7 +3633,7 @@ export interface CommandsRespondToQueuedCommandRequest {
|
|
|
3315
3633
|
result: QueuedCommandResult;
|
|
3316
3634
|
}
|
|
3317
3635
|
/**
|
|
3318
|
-
*
|
|
3636
|
+
* Queued-command response indicating the host executed the command, with an optional flag to stop queue processing.
|
|
3319
3637
|
*
|
|
3320
3638
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3321
3639
|
* via the `definition` "QueuedCommandHandled".
|
|
@@ -3332,7 +3650,7 @@ export interface QueuedCommandHandled {
|
|
|
3332
3650
|
stopProcessingQueue?: boolean;
|
|
3333
3651
|
}
|
|
3334
3652
|
/**
|
|
3335
|
-
*
|
|
3653
|
+
* Queued-command response indicating the host did not execute the command and the queue may continue.
|
|
3336
3654
|
*
|
|
3337
3655
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3338
3656
|
* via the `definition` "QueuedCommandNotHandled".
|
|
@@ -3593,7 +3911,143 @@ export interface CurrentToolMetadata {
|
|
|
3593
3911
|
deferLoading?: boolean;
|
|
3594
3912
|
}
|
|
3595
3913
|
/**
|
|
3596
|
-
*
|
|
3914
|
+
* A file included in the redacted debug bundle.
|
|
3915
|
+
*
|
|
3916
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3917
|
+
* via the `definition` "DebugCollectLogsCollectedEntry".
|
|
3918
|
+
*/
|
|
3919
|
+
/** @experimental */
|
|
3920
|
+
export interface DebugCollectLogsCollectedEntry {
|
|
3921
|
+
/**
|
|
3922
|
+
* Relative path of the file in the staged bundle/archive.
|
|
3923
|
+
*/
|
|
3924
|
+
bundlePath: string;
|
|
3925
|
+
source: DebugCollectLogsSource;
|
|
3926
|
+
/**
|
|
3927
|
+
* Redacted output size in bytes.
|
|
3928
|
+
*/
|
|
3929
|
+
sizeBytes: number;
|
|
3930
|
+
}
|
|
3931
|
+
/**
|
|
3932
|
+
* A caller-provided server-local file or directory to include in the debug bundle.
|
|
3933
|
+
*
|
|
3934
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3935
|
+
* via the `definition` "DebugCollectLogsEntry".
|
|
3936
|
+
*/
|
|
3937
|
+
/** @experimental */
|
|
3938
|
+
export interface DebugCollectLogsEntry {
|
|
3939
|
+
kind: DebugCollectLogsEntryKind;
|
|
3940
|
+
/**
|
|
3941
|
+
* Server-local source path to read.
|
|
3942
|
+
*/
|
|
3943
|
+
path: string;
|
|
3944
|
+
/**
|
|
3945
|
+
* Relative path to use inside the staged bundle/archive.
|
|
3946
|
+
*/
|
|
3947
|
+
bundlePath: string;
|
|
3948
|
+
redaction?: DebugCollectLogsRedaction;
|
|
3949
|
+
/**
|
|
3950
|
+
* When true, collection fails if this entry cannot be read. Defaults to false, which records the entry in `skippedEntries`.
|
|
3951
|
+
*/
|
|
3952
|
+
required?: boolean;
|
|
3953
|
+
}
|
|
3954
|
+
/**
|
|
3955
|
+
* Built-in session diagnostics to include in the bundle. Omitted fields default to true.
|
|
3956
|
+
*
|
|
3957
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3958
|
+
* via the `definition` "DebugCollectLogsInclude".
|
|
3959
|
+
*/
|
|
3960
|
+
/** @experimental */
|
|
3961
|
+
export interface DebugCollectLogsInclude {
|
|
3962
|
+
/**
|
|
3963
|
+
* Include the session event log (`events.jsonl`). Defaults to true.
|
|
3964
|
+
*/
|
|
3965
|
+
events?: boolean;
|
|
3966
|
+
/**
|
|
3967
|
+
* Include process logs for the session. Defaults to true.
|
|
3968
|
+
*/
|
|
3969
|
+
processLogs?: boolean;
|
|
3970
|
+
/**
|
|
3971
|
+
* Include interactive shell logs written under the session's `shell-logs` directory. Defaults to true.
|
|
3972
|
+
*/
|
|
3973
|
+
shellLogs?: boolean;
|
|
3974
|
+
/**
|
|
3975
|
+
* Server-local path to the session's events.jsonl file. Internal callers normally omit this and let the runtime derive it from the session.
|
|
3976
|
+
*/
|
|
3977
|
+
eventsPath?: string;
|
|
3978
|
+
/**
|
|
3979
|
+
* Server-local path to the current process log. When set, it is included as `process.log` and its directory is searched for prior logs from the same session.
|
|
3980
|
+
*/
|
|
3981
|
+
currentProcessLogPath?: string;
|
|
3982
|
+
/**
|
|
3983
|
+
* Server-local process log directory to search when `currentProcessLogPath` is unavailable, useful for collecting logs for inactive sessions.
|
|
3984
|
+
*/
|
|
3985
|
+
processLogDirectory?: string;
|
|
3986
|
+
/**
|
|
3987
|
+
* Maximum number of previous process logs to include. Defaults to 5.
|
|
3988
|
+
*/
|
|
3989
|
+
previousProcessLogLimit?: number;
|
|
3990
|
+
}
|
|
3991
|
+
/**
|
|
3992
|
+
* Options for collecting a redacted session debug bundle.
|
|
3993
|
+
*
|
|
3994
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3995
|
+
* via the `definition` "DebugCollectLogsRequest".
|
|
3996
|
+
*/
|
|
3997
|
+
/** @experimental */
|
|
3998
|
+
export interface DebugCollectLogsRequest {
|
|
3999
|
+
destination: DebugCollectLogsDestination;
|
|
4000
|
+
include?: DebugCollectLogsInclude;
|
|
4001
|
+
/**
|
|
4002
|
+
* Caller-provided server-local files or directories to include in addition to the runtime's built-in session diagnostics. This lets host applications add their own diagnostics without changing the API shape.
|
|
4003
|
+
*/
|
|
4004
|
+
additionalEntries?: DebugCollectLogsEntry[];
|
|
4005
|
+
}
|
|
4006
|
+
/**
|
|
4007
|
+
* Result of collecting a redacted debug bundle.
|
|
4008
|
+
*
|
|
4009
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4010
|
+
* via the `definition` "DebugCollectLogsResult".
|
|
4011
|
+
*/
|
|
4012
|
+
/** @experimental */
|
|
4013
|
+
export interface DebugCollectLogsResult {
|
|
4014
|
+
kind: DebugCollectLogsResultKind;
|
|
4015
|
+
/**
|
|
4016
|
+
* Actual archive path or staging directory path written. This may differ from the requested path when no-overwrite suffixing or fallback-to-temp-directory was needed.
|
|
4017
|
+
*/
|
|
4018
|
+
path: string;
|
|
4019
|
+
/**
|
|
4020
|
+
* Files included in the redacted bundle.
|
|
4021
|
+
*/
|
|
4022
|
+
entries: DebugCollectLogsCollectedEntry[];
|
|
4023
|
+
/**
|
|
4024
|
+
* Optional files or directories that could not be included.
|
|
4025
|
+
*/
|
|
4026
|
+
skippedEntries?: DebugCollectLogsSkippedEntry[];
|
|
4027
|
+
}
|
|
4028
|
+
/**
|
|
4029
|
+
* An optional debug bundle entry that could not be included.
|
|
4030
|
+
*
|
|
4031
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4032
|
+
* via the `definition` "DebugCollectLogsSkippedEntry".
|
|
4033
|
+
*/
|
|
4034
|
+
/** @experimental */
|
|
4035
|
+
export interface DebugCollectLogsSkippedEntry {
|
|
4036
|
+
/**
|
|
4037
|
+
* Relative path requested for this bundle entry.
|
|
4038
|
+
*/
|
|
4039
|
+
bundlePath: string;
|
|
4040
|
+
/**
|
|
4041
|
+
* Server-local source path that could not be read.
|
|
4042
|
+
*/
|
|
4043
|
+
path?: string;
|
|
4044
|
+
/**
|
|
4045
|
+
* Reason the entry was skipped.
|
|
4046
|
+
*/
|
|
4047
|
+
reason: string;
|
|
4048
|
+
}
|
|
4049
|
+
/**
|
|
4050
|
+
* MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state.
|
|
3597
4051
|
*
|
|
3598
4052
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3599
4053
|
* via the `definition` "DiscoveredMcpServer".
|
|
@@ -3747,7 +4201,7 @@ export interface ExecuteCommandResult {
|
|
|
3747
4201
|
error?: string;
|
|
3748
4202
|
}
|
|
3749
4203
|
/**
|
|
3750
|
-
*
|
|
4204
|
+
* Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID.
|
|
3751
4205
|
*
|
|
3752
4206
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3753
4207
|
* via the `definition` "Extension".
|
|
@@ -4263,7 +4717,7 @@ export interface GitHubTelemetryEvent {
|
|
|
4263
4717
|
client?: GitHubTelemetryClientInfo;
|
|
4264
4718
|
}
|
|
4265
4719
|
/**
|
|
4266
|
-
* Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding
|
|
4720
|
+
* Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake.
|
|
4267
4721
|
*
|
|
4268
4722
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4269
4723
|
* via the `definition` "GitHubTelemetryNotification".
|
|
@@ -4271,9 +4725,9 @@ export interface GitHubTelemetryEvent {
|
|
|
4271
4725
|
/** @experimental */
|
|
4272
4726
|
export interface GitHubTelemetryNotification {
|
|
4273
4727
|
/**
|
|
4274
|
-
* Session the telemetry event belongs to.
|
|
4728
|
+
* Session the telemetry event belongs to, when it is session-scoped. Omitted for sessionless events (for example, `server.sendTelemetry` calls with no session id), which are still forwarded to opted-in connections.
|
|
4275
4729
|
*/
|
|
4276
|
-
sessionId
|
|
4730
|
+
sessionId?: string;
|
|
4277
4731
|
/**
|
|
4278
4732
|
* Whether this is a restricted telemetry event (cli.restricted_telemetry). Hosts must route restricted events to first-party Microsoft stores only.
|
|
4279
4733
|
*/
|
|
@@ -4449,7 +4903,7 @@ export interface HistoryTruncateResult {
|
|
|
4449
4903
|
eventsRemoved: number;
|
|
4450
4904
|
}
|
|
4451
4905
|
/**
|
|
4452
|
-
*
|
|
4906
|
+
* Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source.
|
|
4453
4907
|
*
|
|
4454
4908
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4455
4909
|
* via the `definition` "InstalledPlugin".
|
|
@@ -4483,7 +4937,7 @@ export interface InstalledPlugin {
|
|
|
4483
4937
|
source?: InstalledPluginSource;
|
|
4484
4938
|
}
|
|
4485
4939
|
/**
|
|
4486
|
-
*
|
|
4940
|
+
* Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, and optional subpath.
|
|
4487
4941
|
*
|
|
4488
4942
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4489
4943
|
* via the `definition` "InstalledPluginSourceGitHub".
|
|
@@ -4499,7 +4953,7 @@ export interface InstalledPluginSourceGitHub {
|
|
|
4499
4953
|
path?: string;
|
|
4500
4954
|
}
|
|
4501
4955
|
/**
|
|
4502
|
-
*
|
|
4956
|
+
* Source descriptor for a direct URL plugin install, with URL, optional ref, and optional subpath.
|
|
4503
4957
|
*
|
|
4504
4958
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4505
4959
|
* via the `definition` "InstalledPluginSourceUrl".
|
|
@@ -4515,7 +4969,7 @@ export interface InstalledPluginSourceUrl {
|
|
|
4515
4969
|
path?: string;
|
|
4516
4970
|
}
|
|
4517
4971
|
/**
|
|
4518
|
-
*
|
|
4972
|
+
* Source descriptor for a direct local plugin install, with a local filesystem path.
|
|
4519
4973
|
*
|
|
4520
4974
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4521
4975
|
* via the `definition` "InstalledPluginSourceLocal".
|
|
@@ -4558,7 +5012,7 @@ export interface InstalledPluginInfo {
|
|
|
4558
5012
|
enabled: boolean;
|
|
4559
5013
|
}
|
|
4560
5014
|
/**
|
|
4561
|
-
*
|
|
5015
|
+
* Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path.
|
|
4562
5016
|
*
|
|
4563
5017
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4564
5018
|
* via the `definition` "InstructionDiscoveryPath".
|
|
@@ -4641,7 +5095,7 @@ export interface InstructionsGetSourcesResult {
|
|
|
4641
5095
|
sources: InstructionSource[];
|
|
4642
5096
|
}
|
|
4643
5097
|
/**
|
|
4644
|
-
*
|
|
5098
|
+
* Loaded instruction source for a session, including path, content, category, location, applicability, and optional description.
|
|
4645
5099
|
*
|
|
4646
5100
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4647
5101
|
* via the `definition` "InstructionSource".
|
|
@@ -4761,6 +5215,18 @@ export interface LlmInferenceHttpRequestStartRequest {
|
|
|
4761
5215
|
url: string;
|
|
4762
5216
|
headers: LlmInferenceHeaders;
|
|
4763
5217
|
transport?: LlmInferenceHttpRequestStartTransport;
|
|
5218
|
+
/**
|
|
5219
|
+
* Stable per-agent-instance id attributing this request to a specific agent trajectory. Present when the request originates from an agent turn; absent for requests issued outside any agent context (e.g. some SDK callers). A request with an `agentId` but no `parentAgentId` is a root-agent request; one carrying both is a subagent request. Sourced from the runtime's per-request agent context and surfaced on the envelope independently of transport, so it is available for both first-party (CAPI) and BYOK/custom-provider requests; on the CAPI transport the runtime derives the upstream `X-Agent-Task-Id` header from this same context. Consumers routing each provider call to a training trajectory should key on this rather than on lifecycle events, since it is available on the request path before sampling.
|
|
5220
|
+
*/
|
|
5221
|
+
agentId?: string;
|
|
5222
|
+
/**
|
|
5223
|
+
* Id of the parent agent that spawned the agent issuing this request. Present only for subagent requests; absent for root-agent requests and non-agent requests. Combined with `agentId`, this lets consumers attribute a call to a child trajectory versus the root. Like `agentId`, it comes from the runtime's per-request agent context independently of transport; on the CAPI transport the runtime derives the upstream `X-Parent-Agent-Id` header from this same context.
|
|
5224
|
+
*/
|
|
5225
|
+
parentAgentId?: string;
|
|
5226
|
+
/**
|
|
5227
|
+
* Coarse classification of the interaction that produced this request. Open string for forward-compatibility; known values include `conversation-agent`, `conversation-subagent`, `conversation-sampling`, `conversation-background`, `conversation-compaction`, and `conversation-user`. Absent when the runtime did not classify the request. Comes from the runtime's per-request agent context independently of transport; on the CAPI transport the runtime derives the upstream `X-Interaction-Type` header from this same context.
|
|
5228
|
+
*/
|
|
5229
|
+
interactionType?: string;
|
|
4764
5230
|
}
|
|
4765
5231
|
/**
|
|
4766
5232
|
* Acknowledgement. Returning successfully simply means the SDK accepted the start frame; it does not imply the request will succeed.
|
|
@@ -4876,7 +5342,7 @@ export interface LlmInferenceSetProviderResult {
|
|
|
4876
5342
|
success: boolean;
|
|
4877
5343
|
}
|
|
4878
5344
|
/**
|
|
4879
|
-
*
|
|
5345
|
+
* Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID.
|
|
4880
5346
|
*
|
|
4881
5347
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4882
5348
|
* via the `definition` "LocalSessionMetadataValue".
|
|
@@ -5089,7 +5555,7 @@ export interface MarketplaceListResult {
|
|
|
5089
5555
|
marketplaces: MarketplaceInfo[];
|
|
5090
5556
|
}
|
|
5091
5557
|
/**
|
|
5092
|
-
*
|
|
5558
|
+
* Per-marketplace refresh result, including marketplace name, success flag, and optional failure error.
|
|
5093
5559
|
*
|
|
5094
5560
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5095
5561
|
* via the `definition` "MarketplaceRefreshEntry".
|
|
@@ -5140,7 +5606,7 @@ export interface MarketplaceRemoveResult {
|
|
|
5140
5606
|
dependentPlugins?: string[];
|
|
5141
5607
|
}
|
|
5142
5608
|
/**
|
|
5143
|
-
*
|
|
5609
|
+
* MCP server allowed by policy, with server name and optional PII-free explanatory note.
|
|
5144
5610
|
*
|
|
5145
5611
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5146
5612
|
* via the `definition` "McpAllowedServer".
|
|
@@ -5355,7 +5821,7 @@ export interface McpAppsReadResourceResult {
|
|
|
5355
5821
|
contents: McpAppsResourceContent[];
|
|
5356
5822
|
}
|
|
5357
5823
|
/**
|
|
5358
|
-
*
|
|
5824
|
+
* MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata.
|
|
5359
5825
|
*
|
|
5360
5826
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5361
5827
|
* via the `definition` "McpAppsResourceContent".
|
|
@@ -5743,7 +6209,7 @@ export interface McpExecuteSamplingResult {
|
|
|
5743
6209
|
[k: string]: unknown | undefined;
|
|
5744
6210
|
}
|
|
5745
6211
|
/**
|
|
5746
|
-
*
|
|
6212
|
+
* MCP server filtered by policy, with name, reason, optional redacted reason, and enterprise login.
|
|
5747
6213
|
*
|
|
5748
6214
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5749
6215
|
* via the `definition` "McpFilteredServer".
|
|
@@ -5918,7 +6384,7 @@ export interface McpListToolsResult {
|
|
|
5918
6384
|
tools: McpTools[];
|
|
5919
6385
|
}
|
|
5920
6386
|
/**
|
|
5921
|
-
*
|
|
6387
|
+
* MCP tool metadata with tool name and optional description.
|
|
5922
6388
|
*
|
|
5923
6389
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5924
6390
|
* via the `definition` "McpTools".
|
|
@@ -6013,26 +6479,31 @@ export interface McpOauthLoginResult {
|
|
|
6013
6479
|
authorizationUrl?: string;
|
|
6014
6480
|
}
|
|
6015
6481
|
/**
|
|
6016
|
-
*
|
|
6482
|
+
* Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove).
|
|
6017
6483
|
*
|
|
6018
6484
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6019
|
-
* via the `definition` "
|
|
6485
|
+
* via the `definition` "McpRemoveGitHubResult".
|
|
6020
6486
|
*/
|
|
6021
6487
|
/** @experimental */
|
|
6022
|
-
export interface
|
|
6488
|
+
export interface McpRemoveGitHubResult {
|
|
6489
|
+
/**
|
|
6490
|
+
* True when the auto-managed `github` MCP server was removed; false when no removal happened (e.g. user has explicitly configured a `github` server, or the server was not registered).
|
|
6491
|
+
*/
|
|
6492
|
+
removed: boolean;
|
|
6023
6493
|
}
|
|
6024
6494
|
/**
|
|
6025
|
-
*
|
|
6495
|
+
* Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server.
|
|
6026
6496
|
*
|
|
6027
6497
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6028
|
-
* via the `definition` "
|
|
6498
|
+
* via the `definition` "McpRestartServerRequest".
|
|
6029
6499
|
*/
|
|
6030
6500
|
/** @experimental */
|
|
6031
|
-
export interface
|
|
6501
|
+
export interface McpRestartServerRequest {
|
|
6032
6502
|
/**
|
|
6033
|
-
*
|
|
6503
|
+
* Name of the MCP server to restart
|
|
6034
6504
|
*/
|
|
6035
|
-
|
|
6505
|
+
serverName: string;
|
|
6506
|
+
config?: McpServerConfig;
|
|
6036
6507
|
}
|
|
6037
6508
|
/**
|
|
6038
6509
|
* Outcome of an MCP sampling execution: success result, failure error, or cancellation.
|
|
@@ -6050,7 +6521,7 @@ export interface McpSamplingExecutionResult {
|
|
|
6050
6521
|
error?: string;
|
|
6051
6522
|
}
|
|
6052
6523
|
/**
|
|
6053
|
-
*
|
|
6524
|
+
* MCP server status entry, including config source/plugin source and any connection error.
|
|
6054
6525
|
*
|
|
6055
6526
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6056
6527
|
* via the `definition` "McpServer".
|
|
@@ -6110,6 +6581,20 @@ export interface McpSetEnvValueModeParams {
|
|
|
6110
6581
|
export interface McpSetEnvValueModeResult {
|
|
6111
6582
|
mode: McpSetEnvValueModeDetails;
|
|
6112
6583
|
}
|
|
6584
|
+
/**
|
|
6585
|
+
* Server name and configuration for an individual MCP server start.
|
|
6586
|
+
*
|
|
6587
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6588
|
+
* via the `definition` "McpStartServerRequest".
|
|
6589
|
+
*/
|
|
6590
|
+
/** @experimental */
|
|
6591
|
+
export interface McpStartServerRequest {
|
|
6592
|
+
/**
|
|
6593
|
+
* Name of the MCP server to start
|
|
6594
|
+
*/
|
|
6595
|
+
serverName: string;
|
|
6596
|
+
config: McpServerConfig;
|
|
6597
|
+
}
|
|
6113
6598
|
/**
|
|
6114
6599
|
* MCP server startup filtering result.
|
|
6115
6600
|
*
|
|
@@ -6401,7 +6886,7 @@ export interface MetadataSnapshotRemoteMetadataRepository {
|
|
|
6401
6886
|
branch: string;
|
|
6402
6887
|
}
|
|
6403
6888
|
/**
|
|
6404
|
-
*
|
|
6889
|
+
* Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories.
|
|
6405
6890
|
*
|
|
6406
6891
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6407
6892
|
* via the `definition` "Model".
|
|
@@ -6765,6 +7250,7 @@ export interface ModelSwitchToRequest {
|
|
|
6765
7250
|
*/
|
|
6766
7251
|
reasoningEffort?: string;
|
|
6767
7252
|
reasoningSummary?: ReasoningSummary;
|
|
7253
|
+
verbosity?: Verbosity;
|
|
6768
7254
|
modelCapabilities?: ModelCapabilitiesOverride;
|
|
6769
7255
|
contextTier?: ContextTier;
|
|
6770
7256
|
}
|
|
@@ -6896,7 +7382,7 @@ export interface NameSetRequest {
|
|
|
6896
7382
|
name: string;
|
|
6897
7383
|
}
|
|
6898
7384
|
/**
|
|
6899
|
-
*
|
|
7385
|
+
* Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope.
|
|
6900
7386
|
*
|
|
6901
7387
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6902
7388
|
* via the `definition` "OptionsUpdateAdditionalContentExclusionPolicy".
|
|
@@ -6908,7 +7394,7 @@ export interface OptionsUpdateAdditionalContentExclusionPolicy {
|
|
|
6908
7394
|
scope: OptionsUpdateAdditionalContentExclusionPolicyScope;
|
|
6909
7395
|
}
|
|
6910
7396
|
/**
|
|
6911
|
-
*
|
|
7397
|
+
* Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source.
|
|
6912
7398
|
*
|
|
6913
7399
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6914
7400
|
* via the `definition` "OptionsUpdateAdditionalContentExclusionPolicyRule".
|
|
@@ -6921,7 +7407,7 @@ export interface OptionsUpdateAdditionalContentExclusionPolicyRule {
|
|
|
6921
7407
|
source: OptionsUpdateAdditionalContentExclusionPolicyRuleSource;
|
|
6922
7408
|
}
|
|
6923
7409
|
/**
|
|
6924
|
-
*
|
|
7410
|
+
* Source descriptor for a `session.options.update` content-exclusion rule, with source name and type.
|
|
6925
7411
|
*
|
|
6926
7412
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6927
7413
|
* via the `definition` "OptionsUpdateAdditionalContentExclusionPolicyRuleSource".
|
|
@@ -6932,7 +7418,7 @@ export interface OptionsUpdateAdditionalContentExclusionPolicyRuleSource {
|
|
|
6932
7418
|
type: string;
|
|
6933
7419
|
}
|
|
6934
7420
|
/**
|
|
6935
|
-
*
|
|
7421
|
+
* Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details.
|
|
6936
7422
|
*
|
|
6937
7423
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6938
7424
|
* via the `definition` "PendingPermissionRequest".
|
|
@@ -6959,7 +7445,7 @@ export interface PendingPermissionRequestList {
|
|
|
6959
7445
|
items: PendingPermissionRequest[];
|
|
6960
7446
|
}
|
|
6961
7447
|
/**
|
|
6962
|
-
*
|
|
7448
|
+
* Permission-decision request variant to approve only the current permission request.
|
|
6963
7449
|
*
|
|
6964
7450
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6965
7451
|
* via the `definition` "PermissionDecisionApproveOnce".
|
|
@@ -6972,7 +7458,7 @@ export interface PermissionDecisionApproveOnce {
|
|
|
6972
7458
|
kind: "approve-once";
|
|
6973
7459
|
}
|
|
6974
7460
|
/**
|
|
6975
|
-
*
|
|
7461
|
+
* Permission-decision request variant to approve for the rest of the session, with optional tool approval or URL domain.
|
|
6976
7462
|
*
|
|
6977
7463
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6978
7464
|
* via the `definition` "PermissionDecisionApproveForSession".
|
|
@@ -6990,7 +7476,7 @@ export interface PermissionDecisionApproveForSession {
|
|
|
6990
7476
|
domain?: string;
|
|
6991
7477
|
}
|
|
6992
7478
|
/**
|
|
6993
|
-
*
|
|
7479
|
+
* Session-scoped approval details for specific command identifiers.
|
|
6994
7480
|
*
|
|
6995
7481
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6996
7482
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalCommands".
|
|
@@ -7007,7 +7493,7 @@ export interface PermissionDecisionApproveForSessionApprovalCommands {
|
|
|
7007
7493
|
commandIdentifiers: string[];
|
|
7008
7494
|
}
|
|
7009
7495
|
/**
|
|
7010
|
-
*
|
|
7496
|
+
* Session-scoped approval details for read-only filesystem operations.
|
|
7011
7497
|
*
|
|
7012
7498
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7013
7499
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalRead".
|
|
@@ -7020,7 +7506,7 @@ export interface PermissionDecisionApproveForSessionApprovalRead {
|
|
|
7020
7506
|
kind: "read";
|
|
7021
7507
|
}
|
|
7022
7508
|
/**
|
|
7023
|
-
*
|
|
7509
|
+
* Session-scoped approval details for filesystem write operations.
|
|
7024
7510
|
*
|
|
7025
7511
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7026
7512
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalWrite".
|
|
@@ -7033,7 +7519,7 @@ export interface PermissionDecisionApproveForSessionApprovalWrite {
|
|
|
7033
7519
|
kind: "write";
|
|
7034
7520
|
}
|
|
7035
7521
|
/**
|
|
7036
|
-
*
|
|
7522
|
+
* Session-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null.
|
|
7037
7523
|
*
|
|
7038
7524
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7039
7525
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalMcp".
|
|
@@ -7054,7 +7540,7 @@ export interface PermissionDecisionApproveForSessionApprovalMcp {
|
|
|
7054
7540
|
toolName: string | null;
|
|
7055
7541
|
}
|
|
7056
7542
|
/**
|
|
7057
|
-
*
|
|
7543
|
+
* Session-scoped approval details for MCP sampling requests from a server.
|
|
7058
7544
|
*
|
|
7059
7545
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7060
7546
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalMcpSampling".
|
|
@@ -7071,7 +7557,7 @@ export interface PermissionDecisionApproveForSessionApprovalMcpSampling {
|
|
|
7071
7557
|
serverName: string;
|
|
7072
7558
|
}
|
|
7073
7559
|
/**
|
|
7074
|
-
*
|
|
7560
|
+
* Session-scoped approval details for writes to long-term memory.
|
|
7075
7561
|
*
|
|
7076
7562
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7077
7563
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalMemory".
|
|
@@ -7084,7 +7570,7 @@ export interface PermissionDecisionApproveForSessionApprovalMemory {
|
|
|
7084
7570
|
kind: "memory";
|
|
7085
7571
|
}
|
|
7086
7572
|
/**
|
|
7087
|
-
*
|
|
7573
|
+
* Session-scoped approval details for a custom tool, keyed by tool name.
|
|
7088
7574
|
*
|
|
7089
7575
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7090
7576
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalCustomTool".
|
|
@@ -7101,7 +7587,7 @@ export interface PermissionDecisionApproveForSessionApprovalCustomTool {
|
|
|
7101
7587
|
toolName: string;
|
|
7102
7588
|
}
|
|
7103
7589
|
/**
|
|
7104
|
-
*
|
|
7590
|
+
* Session-scoped approval details for extension-management operations, optionally narrowed by operation.
|
|
7105
7591
|
*
|
|
7106
7592
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7107
7593
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionManagement".
|
|
@@ -7118,7 +7604,7 @@ export interface PermissionDecisionApproveForSessionApprovalExtensionManagement
|
|
|
7118
7604
|
operation?: string;
|
|
7119
7605
|
}
|
|
7120
7606
|
/**
|
|
7121
|
-
*
|
|
7607
|
+
* Session-scoped approval details for an extension's permission-gated capability access, keyed by extension name.
|
|
7122
7608
|
*
|
|
7123
7609
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7124
7610
|
* via the `definition` "PermissionDecisionApproveForSessionApprovalExtensionPermissionAccess".
|
|
@@ -7135,7 +7621,7 @@ export interface PermissionDecisionApproveForSessionApprovalExtensionPermissionA
|
|
|
7135
7621
|
extensionName: string;
|
|
7136
7622
|
}
|
|
7137
7623
|
/**
|
|
7138
|
-
*
|
|
7624
|
+
* Permission-decision request variant to approve and persist a permission for a project location, with approval details and location key.
|
|
7139
7625
|
*
|
|
7140
7626
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7141
7627
|
* via the `definition` "PermissionDecisionApproveForLocation".
|
|
@@ -7153,7 +7639,7 @@ export interface PermissionDecisionApproveForLocation {
|
|
|
7153
7639
|
locationKey: string;
|
|
7154
7640
|
}
|
|
7155
7641
|
/**
|
|
7156
|
-
*
|
|
7642
|
+
* Location-scoped approval details for specific command identifiers.
|
|
7157
7643
|
*
|
|
7158
7644
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7159
7645
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalCommands".
|
|
@@ -7170,7 +7656,7 @@ export interface PermissionDecisionApproveForLocationApprovalCommands {
|
|
|
7170
7656
|
commandIdentifiers: string[];
|
|
7171
7657
|
}
|
|
7172
7658
|
/**
|
|
7173
|
-
*
|
|
7659
|
+
* Location-scoped approval details for read-only filesystem operations.
|
|
7174
7660
|
*
|
|
7175
7661
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7176
7662
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalRead".
|
|
@@ -7183,7 +7669,7 @@ export interface PermissionDecisionApproveForLocationApprovalRead {
|
|
|
7183
7669
|
kind: "read";
|
|
7184
7670
|
}
|
|
7185
7671
|
/**
|
|
7186
|
-
*
|
|
7672
|
+
* Location-scoped approval details for filesystem write operations.
|
|
7187
7673
|
*
|
|
7188
7674
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7189
7675
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalWrite".
|
|
@@ -7196,7 +7682,7 @@ export interface PermissionDecisionApproveForLocationApprovalWrite {
|
|
|
7196
7682
|
kind: "write";
|
|
7197
7683
|
}
|
|
7198
7684
|
/**
|
|
7199
|
-
*
|
|
7685
|
+
* Location-scoped approval details for an MCP server tool, or all tools on the server when `toolName` is null.
|
|
7200
7686
|
*
|
|
7201
7687
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7202
7688
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalMcp".
|
|
@@ -7217,7 +7703,7 @@ export interface PermissionDecisionApproveForLocationApprovalMcp {
|
|
|
7217
7703
|
toolName: string | null;
|
|
7218
7704
|
}
|
|
7219
7705
|
/**
|
|
7220
|
-
*
|
|
7706
|
+
* Location-scoped approval details for MCP sampling requests from a server.
|
|
7221
7707
|
*
|
|
7222
7708
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7223
7709
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalMcpSampling".
|
|
@@ -7234,7 +7720,7 @@ export interface PermissionDecisionApproveForLocationApprovalMcpSampling {
|
|
|
7234
7720
|
serverName: string;
|
|
7235
7721
|
}
|
|
7236
7722
|
/**
|
|
7237
|
-
*
|
|
7723
|
+
* Location-scoped approval details for writes to long-term memory.
|
|
7238
7724
|
*
|
|
7239
7725
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7240
7726
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalMemory".
|
|
@@ -7247,7 +7733,7 @@ export interface PermissionDecisionApproveForLocationApprovalMemory {
|
|
|
7247
7733
|
kind: "memory";
|
|
7248
7734
|
}
|
|
7249
7735
|
/**
|
|
7250
|
-
*
|
|
7736
|
+
* Location-scoped approval details for a custom tool, keyed by tool name.
|
|
7251
7737
|
*
|
|
7252
7738
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7253
7739
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalCustomTool".
|
|
@@ -7264,7 +7750,7 @@ export interface PermissionDecisionApproveForLocationApprovalCustomTool {
|
|
|
7264
7750
|
toolName: string;
|
|
7265
7751
|
}
|
|
7266
7752
|
/**
|
|
7267
|
-
*
|
|
7753
|
+
* Location-scoped approval details for extension-management operations, optionally narrowed by operation.
|
|
7268
7754
|
*
|
|
7269
7755
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7270
7756
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionManagement".
|
|
@@ -7281,7 +7767,7 @@ export interface PermissionDecisionApproveForLocationApprovalExtensionManagement
|
|
|
7281
7767
|
operation?: string;
|
|
7282
7768
|
}
|
|
7283
7769
|
/**
|
|
7284
|
-
*
|
|
7770
|
+
* Location-scoped approval details for an extension's permission-gated capability access, keyed by extension name.
|
|
7285
7771
|
*
|
|
7286
7772
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7287
7773
|
* via the `definition` "PermissionDecisionApproveForLocationApprovalExtensionPermissionAccess".
|
|
@@ -7298,7 +7784,7 @@ export interface PermissionDecisionApproveForLocationApprovalExtensionPermission
|
|
|
7298
7784
|
extensionName: string;
|
|
7299
7785
|
}
|
|
7300
7786
|
/**
|
|
7301
|
-
*
|
|
7787
|
+
* Permission-decision request variant to permanently approve a URL domain across sessions.
|
|
7302
7788
|
*
|
|
7303
7789
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7304
7790
|
* via the `definition` "PermissionDecisionApprovePermanently".
|
|
@@ -7315,7 +7801,7 @@ export interface PermissionDecisionApprovePermanently {
|
|
|
7315
7801
|
domain: string;
|
|
7316
7802
|
}
|
|
7317
7803
|
/**
|
|
7318
|
-
*
|
|
7804
|
+
* Permission-decision request variant to reject a pending permission request, with optional feedback.
|
|
7319
7805
|
*
|
|
7320
7806
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7321
7807
|
* via the `definition` "PermissionDecisionReject".
|
|
@@ -7332,7 +7818,7 @@ export interface PermissionDecisionReject {
|
|
|
7332
7818
|
feedback?: string;
|
|
7333
7819
|
}
|
|
7334
7820
|
/**
|
|
7335
|
-
*
|
|
7821
|
+
* Permission-decision variant indicating no user was available to confirm the request.
|
|
7336
7822
|
*
|
|
7337
7823
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7338
7824
|
* via the `definition` "PermissionDecisionUserNotAvailable".
|
|
@@ -7345,7 +7831,7 @@ export interface PermissionDecisionUserNotAvailable {
|
|
|
7345
7831
|
kind: "user-not-available";
|
|
7346
7832
|
}
|
|
7347
7833
|
/**
|
|
7348
|
-
*
|
|
7834
|
+
* Permission-decision variant indicating the request was approved.
|
|
7349
7835
|
*
|
|
7350
7836
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7351
7837
|
* via the `definition` "PermissionDecisionApproved".
|
|
@@ -7358,7 +7844,7 @@ export interface PermissionDecisionApproved {
|
|
|
7358
7844
|
kind: "approved";
|
|
7359
7845
|
}
|
|
7360
7846
|
/**
|
|
7361
|
-
*
|
|
7847
|
+
* Permission-decision variant indicating approval was remembered for the session, with approval details.
|
|
7362
7848
|
*
|
|
7363
7849
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7364
7850
|
* via the `definition` "PermissionDecisionApprovedForSession".
|
|
@@ -7372,7 +7858,7 @@ export interface PermissionDecisionApprovedForSession {
|
|
|
7372
7858
|
approval: UserToolSessionApproval;
|
|
7373
7859
|
}
|
|
7374
7860
|
/**
|
|
7375
|
-
*
|
|
7861
|
+
* Permission-decision variant indicating approval was persisted for a project location, with approval details and location key.
|
|
7376
7862
|
*
|
|
7377
7863
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7378
7864
|
* via the `definition` "PermissionDecisionApprovedForLocation".
|
|
@@ -7390,7 +7876,7 @@ export interface PermissionDecisionApprovedForLocation {
|
|
|
7390
7876
|
locationKey: string;
|
|
7391
7877
|
}
|
|
7392
7878
|
/**
|
|
7393
|
-
*
|
|
7879
|
+
* Permission-decision variant indicating the request was cancelled before use, with an optional reason.
|
|
7394
7880
|
*
|
|
7395
7881
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7396
7882
|
* via the `definition` "PermissionDecisionCancelled".
|
|
@@ -7407,7 +7893,7 @@ export interface PermissionDecisionCancelled {
|
|
|
7407
7893
|
reason?: string;
|
|
7408
7894
|
}
|
|
7409
7895
|
/**
|
|
7410
|
-
*
|
|
7896
|
+
* Permission-decision variant indicating explicit denial by permission rules, with the matching rules.
|
|
7411
7897
|
*
|
|
7412
7898
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7413
7899
|
* via the `definition` "PermissionDecisionDeniedByRules".
|
|
@@ -7424,7 +7910,7 @@ export interface PermissionDecisionDeniedByRules {
|
|
|
7424
7910
|
rules: PermissionRule[];
|
|
7425
7911
|
}
|
|
7426
7912
|
/**
|
|
7427
|
-
*
|
|
7913
|
+
* Permission-decision variant indicating no approval rule matched and user confirmation was unavailable.
|
|
7428
7914
|
*
|
|
7429
7915
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7430
7916
|
* via the `definition` "PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUser".
|
|
@@ -7437,7 +7923,7 @@ export interface PermissionDecisionDeniedNoApprovalRuleAndCouldNotRequestFromUse
|
|
|
7437
7923
|
kind: "denied-no-approval-rule-and-could-not-request-from-user";
|
|
7438
7924
|
}
|
|
7439
7925
|
/**
|
|
7440
|
-
*
|
|
7926
|
+
* Permission-decision variant indicating the user denied an interactive prompt, with optional feedback and force-reject flag.
|
|
7441
7927
|
*
|
|
7442
7928
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7443
7929
|
* via the `definition` "PermissionDecisionDeniedInteractivelyByUser".
|
|
@@ -7458,7 +7944,7 @@ export interface PermissionDecisionDeniedInteractivelyByUser {
|
|
|
7458
7944
|
forceReject?: boolean;
|
|
7459
7945
|
}
|
|
7460
7946
|
/**
|
|
7461
|
-
*
|
|
7947
|
+
* Permission-decision variant indicating denial by content-exclusion policy, with path and message.
|
|
7462
7948
|
*
|
|
7463
7949
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7464
7950
|
* via the `definition` "PermissionDecisionDeniedByContentExclusionPolicy".
|
|
@@ -7479,7 +7965,7 @@ export interface PermissionDecisionDeniedByContentExclusionPolicy {
|
|
|
7479
7965
|
message: string;
|
|
7480
7966
|
}
|
|
7481
7967
|
/**
|
|
7482
|
-
*
|
|
7968
|
+
* Permission-decision variant indicating denial by a permission request hook, with optional message and interrupt flag.
|
|
7483
7969
|
*
|
|
7484
7970
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7485
7971
|
* via the `definition` "PermissionDecisionDeniedByPermissionRequestHook".
|
|
@@ -7528,7 +8014,7 @@ export interface PermissionLocationAddToolApprovalParams {
|
|
|
7528
8014
|
approval: PermissionsLocationsAddToolApprovalDetails;
|
|
7529
8015
|
}
|
|
7530
8016
|
/**
|
|
7531
|
-
*
|
|
8017
|
+
* Location-persisted tool approval details for specific command identifiers.
|
|
7532
8018
|
*
|
|
7533
8019
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7534
8020
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsCommands".
|
|
@@ -7545,7 +8031,7 @@ export interface PermissionsLocationsAddToolApprovalDetailsCommands {
|
|
|
7545
8031
|
commandIdentifiers: string[];
|
|
7546
8032
|
}
|
|
7547
8033
|
/**
|
|
7548
|
-
*
|
|
8034
|
+
* Location-persisted tool approval details for read-only filesystem operations.
|
|
7549
8035
|
*
|
|
7550
8036
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7551
8037
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsRead".
|
|
@@ -7558,7 +8044,7 @@ export interface PermissionsLocationsAddToolApprovalDetailsRead {
|
|
|
7558
8044
|
kind: "read";
|
|
7559
8045
|
}
|
|
7560
8046
|
/**
|
|
7561
|
-
*
|
|
8047
|
+
* Location-persisted tool approval details for filesystem write operations.
|
|
7562
8048
|
*
|
|
7563
8049
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7564
8050
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsWrite".
|
|
@@ -7571,7 +8057,7 @@ export interface PermissionsLocationsAddToolApprovalDetailsWrite {
|
|
|
7571
8057
|
kind: "write";
|
|
7572
8058
|
}
|
|
7573
8059
|
/**
|
|
7574
|
-
*
|
|
8060
|
+
* Location-persisted tool approval details for an MCP server tool, or all tools when `toolName` is null.
|
|
7575
8061
|
*
|
|
7576
8062
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7577
8063
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcp".
|
|
@@ -7592,7 +8078,7 @@ export interface PermissionsLocationsAddToolApprovalDetailsMcp {
|
|
|
7592
8078
|
toolName: string | null;
|
|
7593
8079
|
}
|
|
7594
8080
|
/**
|
|
7595
|
-
*
|
|
8081
|
+
* Location-persisted tool approval details for MCP sampling requests from a server.
|
|
7596
8082
|
*
|
|
7597
8083
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7598
8084
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsMcpSampling".
|
|
@@ -7609,7 +8095,7 @@ export interface PermissionsLocationsAddToolApprovalDetailsMcpSampling {
|
|
|
7609
8095
|
serverName: string;
|
|
7610
8096
|
}
|
|
7611
8097
|
/**
|
|
7612
|
-
*
|
|
8098
|
+
* Location-persisted tool approval details for writes to long-term memory.
|
|
7613
8099
|
*
|
|
7614
8100
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7615
8101
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsMemory".
|
|
@@ -7622,7 +8108,7 @@ export interface PermissionsLocationsAddToolApprovalDetailsMemory {
|
|
|
7622
8108
|
kind: "memory";
|
|
7623
8109
|
}
|
|
7624
8110
|
/**
|
|
7625
|
-
*
|
|
8111
|
+
* Location-persisted tool approval details for a custom tool, keyed by tool name.
|
|
7626
8112
|
*
|
|
7627
8113
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7628
8114
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsCustomTool".
|
|
@@ -7639,7 +8125,7 @@ export interface PermissionsLocationsAddToolApprovalDetailsCustomTool {
|
|
|
7639
8125
|
toolName: string;
|
|
7640
8126
|
}
|
|
7641
8127
|
/**
|
|
7642
|
-
*
|
|
8128
|
+
* Location-persisted tool approval details for extension-management operations, optionally narrowed by operation.
|
|
7643
8129
|
*
|
|
7644
8130
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7645
8131
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionManagement".
|
|
@@ -7656,7 +8142,7 @@ export interface PermissionsLocationsAddToolApprovalDetailsExtensionManagement {
|
|
|
7656
8142
|
operation?: string;
|
|
7657
8143
|
}
|
|
7658
8144
|
/**
|
|
7659
|
-
*
|
|
8145
|
+
* Location-persisted tool approval details for an extension's permission-gated capability access, keyed by extension name.
|
|
7660
8146
|
*
|
|
7661
8147
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7662
8148
|
* via the `definition` "PermissionsLocationsAddToolApprovalDetailsExtensionPermissionAccess".
|
|
@@ -7906,7 +8392,7 @@ export interface PermissionRulesSet {
|
|
|
7906
8392
|
denied: PermissionRule[];
|
|
7907
8393
|
}
|
|
7908
8394
|
/**
|
|
7909
|
-
*
|
|
8395
|
+
* Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope.
|
|
7910
8396
|
*
|
|
7911
8397
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7912
8398
|
* via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicy".
|
|
@@ -7918,7 +8404,7 @@ export interface PermissionsConfigureAdditionalContentExclusionPolicy {
|
|
|
7918
8404
|
scope: PermissionsConfigureAdditionalContentExclusionPolicyScope;
|
|
7919
8405
|
}
|
|
7920
8406
|
/**
|
|
7921
|
-
*
|
|
8407
|
+
* Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source.
|
|
7922
8408
|
*
|
|
7923
8409
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7924
8410
|
* via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRule".
|
|
@@ -7931,7 +8417,7 @@ export interface PermissionsConfigureAdditionalContentExclusionPolicyRule {
|
|
|
7931
8417
|
source: PermissionsConfigureAdditionalContentExclusionPolicyRuleSource;
|
|
7932
8418
|
}
|
|
7933
8419
|
/**
|
|
7934
|
-
*
|
|
8420
|
+
* Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type.
|
|
7935
8421
|
*
|
|
7936
8422
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7937
8423
|
* via the `definition` "PermissionsConfigureAdditionalContentExclusionPolicyRuleSource".
|
|
@@ -8145,17 +8631,22 @@ export interface PermissionsResetSessionApprovalsResult {
|
|
|
8145
8631
|
success: boolean;
|
|
8146
8632
|
}
|
|
8147
8633
|
/**
|
|
8148
|
-
*
|
|
8634
|
+
* Allow-all mode to apply for the session.
|
|
8149
8635
|
*
|
|
8150
8636
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
8151
8637
|
* via the `definition` "PermissionsSetAllowAllRequest".
|
|
8152
8638
|
*/
|
|
8153
8639
|
/** @experimental */
|
|
8154
8640
|
export interface PermissionsSetAllowAllRequest {
|
|
8641
|
+
mode?: PermissionsAllowAllMode;
|
|
8155
8642
|
/**
|
|
8156
|
-
*
|
|
8643
|
+
* Legacy full allow-all toggle. Prefer `mode`; when `mode` is omitted, `enabled: true` is treated as `mode: "on"` and any other value is treated as `mode: "off"`.
|
|
8157
8644
|
*/
|
|
8158
|
-
enabled
|
|
8645
|
+
enabled?: boolean;
|
|
8646
|
+
/**
|
|
8647
|
+
* Optional model id for the `auto` mode auto-approval LLM judging. Only meaningful when `mode` is `auto`; ignored otherwise. When omitted, the session's active model is used.
|
|
8648
|
+
*/
|
|
8649
|
+
model?: string;
|
|
8159
8650
|
source?: PermissionsSetAllowAllSource;
|
|
8160
8651
|
}
|
|
8161
8652
|
/**
|
|
@@ -8378,7 +8869,7 @@ export interface PlanUpdateRequest {
|
|
|
8378
8869
|
content: string;
|
|
8379
8870
|
}
|
|
8380
8871
|
/**
|
|
8381
|
-
*
|
|
8872
|
+
* Session plugin metadata, with name, marketplace, optional version, and enabled state.
|
|
8382
8873
|
*
|
|
8383
8874
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
8384
8875
|
* via the `definition` "Plugin".
|
|
@@ -8563,6 +9054,10 @@ export interface PluginsReloadRequest {
|
|
|
8563
9054
|
* Re-load user, plugin, and (subject to `deferRepoHooks`) repo hooks. Defaults to true. Has no effect when the host has not registered a hook reloader (e.g. remote sessions).
|
|
8564
9055
|
*/
|
|
8565
9056
|
reloadHooks?: boolean;
|
|
9057
|
+
/**
|
|
9058
|
+
* Re-discover and relaunch subprocess extensions (including plugin-shipped extensions) after refreshing plugins. Defaults to true. Has no effect when the session has no active extension controller (e.g. extensions were not requested for the session).
|
|
9059
|
+
*/
|
|
9060
|
+
reloadExtensions?: boolean;
|
|
8566
9061
|
/**
|
|
8567
9062
|
* When true, skip repo-level hooks during the hook reload. Use before folder trust is confirmed; load them post-trust via `sessions.loadDeferredRepoHooks`.
|
|
8568
9063
|
*/
|
|
@@ -8599,7 +9094,7 @@ export interface PluginsUpdateRequest {
|
|
|
8599
9094
|
name: string;
|
|
8600
9095
|
}
|
|
8601
9096
|
/**
|
|
8602
|
-
*
|
|
9097
|
+
* Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error.
|
|
8603
9098
|
*
|
|
8604
9099
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
8605
9100
|
* via the `definition` "PluginUpdateAllEntry".
|
|
@@ -9351,7 +9846,7 @@ export interface PushAttachmentBlob {
|
|
|
9351
9846
|
displayName?: string;
|
|
9352
9847
|
}
|
|
9353
9848
|
/**
|
|
9354
|
-
*
|
|
9849
|
+
* User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change.
|
|
9355
9850
|
*
|
|
9356
9851
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9357
9852
|
* via the `definition` "QueuePendingItems".
|
|
@@ -9403,7 +9898,7 @@ export interface QueueRemoveMostRecentResult {
|
|
|
9403
9898
|
/** @experimental */
|
|
9404
9899
|
export interface RegisterEventInterestParams {
|
|
9405
9900
|
/**
|
|
9406
|
-
* The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates
|
|
9901
|
+
* The event type the consumer wants the runtime to treat as 'observed' for behavior-switching gating. Some runtime code paths inspect whether any consumer is interested in a specific event type and choose a different implementation accordingly (e.g. `mcp.oauth_required`: when interest is registered the runtime delegates OAuth token acquisition to the consumer; when no interest is registered OAuth-required servers become needs-auth). SDK clients that long-poll events do NOT automatically appear as listeners to these gating checks — they must explicitly call `registerInterest` for each event type they want the runtime to count as having a consumer. Multiple registrations for the same event type from the same or different consumers are tracked independently and must each be released. See: `mcp.oauth_required`, `sampling.requested`, `auto_mode_switch.requested`, `session_limits_exhausted.requested`, `user_input.requested`, `elicitation.requested`, `command.queued`, `exit_plan_mode.requested`.
|
|
9407
9902
|
*/
|
|
9408
9903
|
eventType: string;
|
|
9409
9904
|
}
|
|
@@ -9836,14 +10331,6 @@ export interface SandboxConfigUserPolicyNetwork {
|
|
|
9836
10331
|
* Whether traffic to local/loopback addresses is allowed.
|
|
9837
10332
|
*/
|
|
9838
10333
|
allowLocalNetwork?: boolean;
|
|
9839
|
-
/**
|
|
9840
|
-
* Hosts allowed in addition to the base policy.
|
|
9841
|
-
*/
|
|
9842
|
-
allowedHosts?: string[];
|
|
9843
|
-
/**
|
|
9844
|
-
* Hosts explicitly blocked.
|
|
9845
|
-
*/
|
|
9846
|
-
blockedHosts?: string[];
|
|
9847
10334
|
}
|
|
9848
10335
|
/**
|
|
9849
10336
|
* macOS seatbelt-specific options.
|
|
@@ -9882,7 +10369,7 @@ export interface SandboxConfigUserPolicyExperimentalSeatbelt {
|
|
|
9882
10369
|
keychainAccess?: boolean;
|
|
9883
10370
|
}
|
|
9884
10371
|
/**
|
|
9885
|
-
*
|
|
10372
|
+
* Scheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time.
|
|
9886
10373
|
*
|
|
9887
10374
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9888
10375
|
* via the `definition` "ScheduleEntry".
|
|
@@ -10009,6 +10496,81 @@ export interface SendAttachmentsToMessageParams {
|
|
|
10009
10496
|
*/
|
|
10010
10497
|
attachments: PushAttachment[];
|
|
10011
10498
|
}
|
|
10499
|
+
/**
|
|
10500
|
+
* A single user message to append to the session as part of a `session.sendMessages` turn
|
|
10501
|
+
*
|
|
10502
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10503
|
+
* via the `definition` "SendMessageItem".
|
|
10504
|
+
*/
|
|
10505
|
+
/** @experimental */
|
|
10506
|
+
export interface SendMessageItem {
|
|
10507
|
+
/**
|
|
10508
|
+
* The user message text
|
|
10509
|
+
*/
|
|
10510
|
+
prompt: string;
|
|
10511
|
+
/**
|
|
10512
|
+
* If provided, this is shown in the timeline instead of `prompt`
|
|
10513
|
+
*/
|
|
10514
|
+
displayPrompt?: string;
|
|
10515
|
+
/**
|
|
10516
|
+
* Optional attachments (files, directories, selections, blobs, GitHub references) to include with this message
|
|
10517
|
+
*/
|
|
10518
|
+
attachments?: Attachment[];
|
|
10519
|
+
/**
|
|
10520
|
+
* If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange
|
|
10521
|
+
*/
|
|
10522
|
+
requiredTool?: string;
|
|
10523
|
+
}
|
|
10524
|
+
/**
|
|
10525
|
+
* Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error.
|
|
10526
|
+
*
|
|
10527
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10528
|
+
* via the `definition` "SendMessagesRequest".
|
|
10529
|
+
*/
|
|
10530
|
+
/** @experimental */
|
|
10531
|
+
export interface SendMessagesRequest {
|
|
10532
|
+
/**
|
|
10533
|
+
* 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.
|
|
10534
|
+
*/
|
|
10535
|
+
messages: SendMessageItem[];
|
|
10536
|
+
mode?: SendMode;
|
|
10537
|
+
/**
|
|
10538
|
+
* If true, adds the messages to the front of the queue instead of the end
|
|
10539
|
+
*/
|
|
10540
|
+
prepend?: boolean;
|
|
10541
|
+
agentMode?: SendAgentMode;
|
|
10542
|
+
/**
|
|
10543
|
+
* Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key.
|
|
10544
|
+
*/
|
|
10545
|
+
requestHeaders?: {
|
|
10546
|
+
[k: string]: string | undefined;
|
|
10547
|
+
};
|
|
10548
|
+
/**
|
|
10549
|
+
* W3C Trace Context traceparent header for distributed tracing of this agent turn
|
|
10550
|
+
*/
|
|
10551
|
+
traceparent?: string;
|
|
10552
|
+
/**
|
|
10553
|
+
* W3C Trace Context tracestate header for distributed tracing
|
|
10554
|
+
*/
|
|
10555
|
+
tracestate?: string;
|
|
10556
|
+
/**
|
|
10557
|
+
* If true, await completion of the agentic loop for this turn before returning. Defaults to false (fire-and-forget). When true, the result still contains the same `messageIds`; the caller can rely on the agent having processed the messages before the call resolves.
|
|
10558
|
+
*/
|
|
10559
|
+
wait?: boolean;
|
|
10560
|
+
}
|
|
10561
|
+
/**
|
|
10562
|
+
* Result of sending zero or more user messages
|
|
10563
|
+
*
|
|
10564
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10565
|
+
* via the `definition` "SendMessagesResult".
|
|
10566
|
+
*/
|
|
10567
|
+
/** @experimental */
|
|
10568
|
+
export interface SendMessagesResult {
|
|
10569
|
+
/**
|
|
10570
|
+
* Unique identifiers assigned to the messages, one per provided message in order. Empty when no messages were provided.
|
|
10571
|
+
*/
|
|
10572
|
+
messageIds: string[];
|
|
10573
|
+
}
|
|
10012
10574
|
/**
|
|
10013
10575
|
* Parameters for sending a user message to the session
|
|
10014
10576
|
*
|
|
@@ -10102,7 +10664,7 @@ export interface ServerInstructionSourceList {
|
|
|
10102
10664
|
sources: InstructionSource[];
|
|
10103
10665
|
}
|
|
10104
10666
|
/**
|
|
10105
|
-
*
|
|
10667
|
+
* Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint.
|
|
10106
10668
|
*
|
|
10107
10669
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10108
10670
|
* via the `definition` "ServerSkill".
|
|
@@ -10353,7 +10915,7 @@ export interface SessionFsReaddirResult {
|
|
|
10353
10915
|
error?: SessionFsError;
|
|
10354
10916
|
}
|
|
10355
10917
|
/**
|
|
10356
|
-
*
|
|
10918
|
+
* Directory entry returned by session filesystem `readdirWithTypes`, with name and entry type.
|
|
10357
10919
|
*
|
|
10358
10920
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10359
10921
|
* via the `definition` "SessionFsReaddirWithTypesEntry".
|
|
@@ -10657,7 +11219,7 @@ export interface SessionFsWriteFileRequest {
|
|
|
10657
11219
|
mode?: number;
|
|
10658
11220
|
}
|
|
10659
11221
|
/**
|
|
10660
|
-
*
|
|
11222
|
+
* Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source.
|
|
10661
11223
|
*
|
|
10662
11224
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10663
11225
|
* via the `definition` "SessionInstalledPlugin".
|
|
@@ -10691,7 +11253,7 @@ export interface SessionInstalledPlugin {
|
|
|
10691
11253
|
source?: SessionInstalledPluginSource;
|
|
10692
11254
|
}
|
|
10693
11255
|
/**
|
|
10694
|
-
*
|
|
11256
|
+
* Source descriptor for a direct GitHub plugin install, with `owner/repo`, optional ref, and optional subpath.
|
|
10695
11257
|
*
|
|
10696
11258
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10697
11259
|
* via the `definition` "SessionInstalledPluginSourceGitHub".
|
|
@@ -10707,7 +11269,7 @@ export interface SessionInstalledPluginSourceGitHub {
|
|
|
10707
11269
|
path?: string;
|
|
10708
11270
|
}
|
|
10709
11271
|
/**
|
|
10710
|
-
*
|
|
11272
|
+
* Source descriptor for a direct URL plugin install, with URL, optional ref, and optional subpath.
|
|
10711
11273
|
*
|
|
10712
11274
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10713
11275
|
* via the `definition` "SessionInstalledPluginSourceUrl".
|
|
@@ -10723,7 +11285,7 @@ export interface SessionInstalledPluginSourceUrl {
|
|
|
10723
11285
|
path?: string;
|
|
10724
11286
|
}
|
|
10725
11287
|
/**
|
|
10726
|
-
*
|
|
11288
|
+
* Source descriptor for a direct local plugin install, with a local filesystem path.
|
|
10727
11289
|
*
|
|
10728
11290
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10729
11291
|
* via the `definition` "SessionInstalledPluginSourceLocal".
|
|
@@ -10898,6 +11460,7 @@ export interface SessionOpenOptions {
|
|
|
10898
11460
|
*/
|
|
10899
11461
|
reasoningEffort?: string;
|
|
10900
11462
|
reasoningSummary?: SessionOpenOptionsReasoningSummary;
|
|
11463
|
+
verbosity?: Verbosity;
|
|
10901
11464
|
/**
|
|
10902
11465
|
* Identifier of the client driving the session.
|
|
10903
11466
|
*/
|
|
@@ -10914,6 +11477,10 @@ export interface SessionOpenOptions {
|
|
|
10914
11477
|
* Stable integration identifier for analytics.
|
|
10915
11478
|
*/
|
|
10916
11479
|
integrationId?: string;
|
|
11480
|
+
/**
|
|
11481
|
+
* Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap.
|
|
11482
|
+
*/
|
|
11483
|
+
enableManagedSettings?: boolean;
|
|
10917
11484
|
/**
|
|
10918
11485
|
* Feature-flag values resolved by the host.
|
|
10919
11486
|
*/
|
|
@@ -11091,7 +11658,7 @@ export interface SessionOpenOptions {
|
|
|
11091
11658
|
sessionCapabilities?: SessionCapability[];
|
|
11092
11659
|
}
|
|
11093
11660
|
/**
|
|
11094
|
-
*
|
|
11661
|
+
* Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope.
|
|
11095
11662
|
*
|
|
11096
11663
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11097
11664
|
* via the `definition` "SessionOpenOptionsAdditionalContentExclusionPolicy".
|
|
@@ -11103,7 +11670,7 @@ export interface SessionOpenOptionsAdditionalContentExclusionPolicy {
|
|
|
11103
11670
|
scope: SessionOpenOptionsAdditionalContentExclusionPolicyScope;
|
|
11104
11671
|
}
|
|
11105
11672
|
/**
|
|
11106
|
-
*
|
|
11673
|
+
* Single content-exclusion rule supplied to `sessions.open` options, with paths, match conditions, and source.
|
|
11107
11674
|
*
|
|
11108
11675
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11109
11676
|
* via the `definition` "SessionOpenOptionsAdditionalContentExclusionPolicyRule".
|
|
@@ -11116,7 +11683,7 @@ export interface SessionOpenOptionsAdditionalContentExclusionPolicyRule {
|
|
|
11116
11683
|
source: SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource;
|
|
11117
11684
|
}
|
|
11118
11685
|
/**
|
|
11119
|
-
*
|
|
11686
|
+
* Source descriptor for a `sessions.open` content-exclusion rule, with source name and type.
|
|
11120
11687
|
*
|
|
11121
11688
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11122
11689
|
* via the `definition` "SessionOpenOptionsAdditionalContentExclusionPolicyRuleSource".
|
|
@@ -11288,7 +11855,7 @@ export interface SessionOpenResult {
|
|
|
11288
11855
|
progress?: SessionsOpenProgress[];
|
|
11289
11856
|
}
|
|
11290
11857
|
/**
|
|
11291
|
-
*
|
|
11858
|
+
* `sessions.open` handoff progress update with step, status, and optional message.
|
|
11292
11859
|
*
|
|
11293
11860
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11294
11861
|
* via the `definition` "SessionsOpenProgress".
|
|
@@ -11432,6 +11999,134 @@ export interface SessionSetCredentialsResult {
|
|
|
11432
11999
|
*/
|
|
11433
12000
|
copilotUserResolved?: boolean;
|
|
11434
12001
|
}
|
|
12002
|
+
/**
|
|
12003
|
+
* Availability of built-in job tools surfaced to boundary consumers.
|
|
12004
|
+
*
|
|
12005
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12006
|
+
* via the `definition` "SessionSettingsBuiltInToolAvailabilitySnapshot".
|
|
12007
|
+
*/
|
|
12008
|
+
/** @experimental */
|
|
12009
|
+
export interface SessionSettingsBuiltInToolAvailabilitySnapshot {
|
|
12010
|
+
reportProgress?: boolean;
|
|
12011
|
+
createPullRequest?: boolean;
|
|
12012
|
+
}
|
|
12013
|
+
/**
|
|
12014
|
+
* Named Rust-owned settings predicate to evaluate for this session.
|
|
12015
|
+
*
|
|
12016
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12017
|
+
* via the `definition` "SessionSettingsEvaluatePredicateRequest".
|
|
12018
|
+
*/
|
|
12019
|
+
/** @experimental */
|
|
12020
|
+
export interface SessionSettingsEvaluatePredicateRequest {
|
|
12021
|
+
name: SessionSettingsPredicateName;
|
|
12022
|
+
/**
|
|
12023
|
+
* Tool name for tool-scoped predicates such as trivial-change handling.
|
|
12024
|
+
*/
|
|
12025
|
+
toolName?: string;
|
|
12026
|
+
}
|
|
12027
|
+
/**
|
|
12028
|
+
* Result of evaluating a Rust-owned settings predicate.
|
|
12029
|
+
*
|
|
12030
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12031
|
+
* via the `definition` "SessionSettingsEvaluatePredicateResult".
|
|
12032
|
+
*/
|
|
12033
|
+
/** @experimental */
|
|
12034
|
+
export interface SessionSettingsEvaluatePredicateResult {
|
|
12035
|
+
enabled: boolean;
|
|
12036
|
+
}
|
|
12037
|
+
/**
|
|
12038
|
+
* Redacted job settings for a session. The job nonce is excluded.
|
|
12039
|
+
*
|
|
12040
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12041
|
+
* via the `definition` "SessionSettingsJobSnapshot".
|
|
12042
|
+
*/
|
|
12043
|
+
/** @experimental */
|
|
12044
|
+
export interface SessionSettingsJobSnapshot {
|
|
12045
|
+
eventType?: string;
|
|
12046
|
+
isTriggerJob?: boolean;
|
|
12047
|
+
builtInToolAvailability?: SessionSettingsBuiltInToolAvailabilitySnapshot;
|
|
12048
|
+
}
|
|
12049
|
+
/**
|
|
12050
|
+
* Redacted model routing settings for a session.
|
|
12051
|
+
*
|
|
12052
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12053
|
+
* via the `definition` "SessionSettingsModelSnapshot".
|
|
12054
|
+
*/
|
|
12055
|
+
/** @experimental */
|
|
12056
|
+
export interface SessionSettingsModelSnapshot {
|
|
12057
|
+
model?: string;
|
|
12058
|
+
defaultReasoningEffort?: string;
|
|
12059
|
+
instanceId?: string;
|
|
12060
|
+
callbackUrl?: string;
|
|
12061
|
+
}
|
|
12062
|
+
/**
|
|
12063
|
+
* Online-evaluation settings safe to expose across the SDK boundary.
|
|
12064
|
+
*
|
|
12065
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12066
|
+
* via the `definition` "SessionSettingsOnlineEvaluationSnapshot".
|
|
12067
|
+
*/
|
|
12068
|
+
/** @experimental */
|
|
12069
|
+
export interface SessionSettingsOnlineEvaluationSnapshot {
|
|
12070
|
+
disableOnlineEvaluation?: boolean;
|
|
12071
|
+
enableOnlineEvaluationOutputFile?: boolean;
|
|
12072
|
+
}
|
|
12073
|
+
/**
|
|
12074
|
+
* Redacted repository and GitHub host settings for a session.
|
|
12075
|
+
*
|
|
12076
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12077
|
+
* via the `definition` "SessionSettingsRepoSnapshot".
|
|
12078
|
+
*/
|
|
12079
|
+
/** @experimental */
|
|
12080
|
+
export interface SessionSettingsRepoSnapshot {
|
|
12081
|
+
name?: string;
|
|
12082
|
+
id?: number;
|
|
12083
|
+
branch?: string;
|
|
12084
|
+
commit?: string;
|
|
12085
|
+
readWrite?: boolean;
|
|
12086
|
+
ownerName?: string;
|
|
12087
|
+
ownerId?: number;
|
|
12088
|
+
serverUrl?: string;
|
|
12089
|
+
host?: string;
|
|
12090
|
+
hostProtocol?: string;
|
|
12091
|
+
secretScanningUrl?: string;
|
|
12092
|
+
prCommitCount?: number;
|
|
12093
|
+
}
|
|
12094
|
+
/**
|
|
12095
|
+
* Redacted, serializable view of session runtime settings for SDK boundary consumers. Secrets and raw feature flags are intentionally excluded.
|
|
12096
|
+
*
|
|
12097
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12098
|
+
* via the `definition` "SessionSettingsSnapshot".
|
|
12099
|
+
*/
|
|
12100
|
+
/** @experimental */
|
|
12101
|
+
export interface SessionSettingsSnapshot {
|
|
12102
|
+
version?: string;
|
|
12103
|
+
clientName?: string;
|
|
12104
|
+
timeoutMs?: number;
|
|
12105
|
+
startTimeMs?: number;
|
|
12106
|
+
repo: SessionSettingsRepoSnapshot;
|
|
12107
|
+
model: SessionSettingsModelSnapshot;
|
|
12108
|
+
validation: SessionSettingsValidationSnapshot;
|
|
12109
|
+
job: SessionSettingsJobSnapshot;
|
|
12110
|
+
onlineEvaluation: SessionSettingsOnlineEvaluationSnapshot;
|
|
12111
|
+
}
|
|
12112
|
+
/**
|
|
12113
|
+
* Redacted validation and memory-tool settings for a session.
|
|
12114
|
+
*
|
|
12115
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12116
|
+
* via the `definition` "SessionSettingsValidationSnapshot".
|
|
12117
|
+
*/
|
|
12118
|
+
/** @experimental */
|
|
12119
|
+
export interface SessionSettingsValidationSnapshot {
|
|
12120
|
+
timeout?: number;
|
|
12121
|
+
dependabotTimeout?: number;
|
|
12122
|
+
codeqlEnabled?: boolean;
|
|
12123
|
+
codeReviewEnabled?: boolean;
|
|
12124
|
+
codeReviewModel?: string;
|
|
12125
|
+
advisoryEnabled?: boolean;
|
|
12126
|
+
secretScanningEnabled?: boolean;
|
|
12127
|
+
memoryStoreEnabled?: boolean;
|
|
12128
|
+
memoryVoteEnabled?: boolean;
|
|
12129
|
+
}
|
|
11435
12130
|
/**
|
|
11436
12131
|
* UUID prefix to resolve to a unique session ID.
|
|
11437
12132
|
*
|
|
@@ -11877,6 +12572,7 @@ export interface SessionUpdateOptionsParams {
|
|
|
11877
12572
|
*/
|
|
11878
12573
|
reasoningEffort?: string;
|
|
11879
12574
|
reasoningSummary?: OptionsUpdateReasoningSummary;
|
|
12575
|
+
verbosity?: Verbosity;
|
|
11880
12576
|
/**
|
|
11881
12577
|
* Identifier of the client driving the session.
|
|
11882
12578
|
*/
|
|
@@ -12179,7 +12875,7 @@ export interface ShutdownRequest {
|
|
|
12179
12875
|
reason?: string;
|
|
12180
12876
|
}
|
|
12181
12877
|
/**
|
|
12182
|
-
*
|
|
12878
|
+
* Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint.
|
|
12183
12879
|
*
|
|
12184
12880
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12185
12881
|
* via the `definition` "Skill".
|
|
@@ -12217,7 +12913,7 @@ export interface Skill {
|
|
|
12217
12913
|
argumentHint?: string;
|
|
12218
12914
|
}
|
|
12219
12915
|
/**
|
|
12220
|
-
*
|
|
12916
|
+
* Canonical directory where skills can be discovered or created, with scope, preference, and optional project path.
|
|
12221
12917
|
*
|
|
12222
12918
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12223
12919
|
* via the `definition` "SkillDiscoveryPath".
|
|
@@ -12355,7 +13051,7 @@ export interface SkillsGetInvokedResult {
|
|
|
12355
13051
|
skills: SkillsInvokedSkill[];
|
|
12356
13052
|
}
|
|
12357
13053
|
/**
|
|
12358
|
-
*
|
|
13054
|
+
* Skill invocation record with name, path, content, allowed tools, and turn number.
|
|
12359
13055
|
*
|
|
12360
13056
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12361
13057
|
* via the `definition` "SkillsInvokedSkill".
|
|
@@ -12401,7 +13097,7 @@ export interface SkillsLoadDiagnostics {
|
|
|
12401
13097
|
errors: string[];
|
|
12402
13098
|
}
|
|
12403
13099
|
/**
|
|
12404
|
-
*
|
|
13100
|
+
* Slash-command invocation result that submits an agent prompt, with display prompt, optional mode, and settings-change flag.
|
|
12405
13101
|
*
|
|
12406
13102
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12407
13103
|
* via the `definition` "SlashCommandAgentPromptResult".
|
|
@@ -12427,7 +13123,7 @@ export interface SlashCommandAgentPromptResult {
|
|
|
12427
13123
|
runtimeSettingsChanged?: boolean;
|
|
12428
13124
|
}
|
|
12429
13125
|
/**
|
|
12430
|
-
*
|
|
13126
|
+
* Slash-command invocation result indicating completion, with optional message and settings-change flag.
|
|
12431
13127
|
*
|
|
12432
13128
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12433
13129
|
* via the `definition` "SlashCommandCompletedResult".
|
|
@@ -12448,7 +13144,7 @@ export interface SlashCommandCompletedResult {
|
|
|
12448
13144
|
runtimeSettingsChanged?: boolean;
|
|
12449
13145
|
}
|
|
12450
13146
|
/**
|
|
12451
|
-
*
|
|
13147
|
+
* Slash-command invocation result containing text output plus Markdown/ANSI rendering flags.
|
|
12452
13148
|
*
|
|
12453
13149
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12454
13150
|
* via the `definition` "SlashCommandTextResult".
|
|
@@ -12477,7 +13173,7 @@ export interface SlashCommandTextResult {
|
|
|
12477
13173
|
runtimeSettingsChanged?: boolean;
|
|
12478
13174
|
}
|
|
12479
13175
|
/**
|
|
12480
|
-
*
|
|
13176
|
+
* Slash-command invocation result asking the client to present subcommand options for a parent command.
|
|
12481
13177
|
*
|
|
12482
13178
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12483
13179
|
* via the `definition` "SlashCommandSelectSubcommandResult".
|
|
@@ -12506,7 +13202,7 @@ export interface SlashCommandSelectSubcommandResult {
|
|
|
12506
13202
|
runtimeSettingsChanged?: boolean;
|
|
12507
13203
|
}
|
|
12508
13204
|
/**
|
|
12509
|
-
*
|
|
13205
|
+
* Selectable slash-command subcommand option with name, description, and optional group label.
|
|
12510
13206
|
*
|
|
12511
13207
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12512
13208
|
* via the `definition` "SlashCommandSelectSubcommandOption".
|
|
@@ -12545,7 +13241,7 @@ export interface SubagentSettingsEntry {
|
|
|
12545
13241
|
contextTier?: SubagentSettingsEntryContextTier;
|
|
12546
13242
|
}
|
|
12547
13243
|
/**
|
|
12548
|
-
*
|
|
13244
|
+
* Tracked background agent task metadata, including IDs, status, timing, agent type, prompt, model, result, and latest response.
|
|
12549
13245
|
*
|
|
12550
13246
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12551
13247
|
* via the `definition` "TaskAgentInfo".
|
|
@@ -12624,7 +13320,7 @@ export interface TaskAgentInfo {
|
|
|
12624
13320
|
idleSince?: string;
|
|
12625
13321
|
}
|
|
12626
13322
|
/**
|
|
12627
|
-
*
|
|
13323
|
+
* Progress snapshot for an agent task, with recent activity lines and optional latest intent.
|
|
12628
13324
|
*
|
|
12629
13325
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12630
13326
|
* via the `definition` "TaskAgentProgress".
|
|
@@ -12645,7 +13341,7 @@ export interface TaskAgentProgress {
|
|
|
12645
13341
|
latestIntent?: string;
|
|
12646
13342
|
}
|
|
12647
13343
|
/**
|
|
12648
|
-
*
|
|
13344
|
+
* Timestamped display line for task progress output or recent agent activity.
|
|
12649
13345
|
*
|
|
12650
13346
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12651
13347
|
* via the `definition` "TaskProgressLine".
|
|
@@ -12662,7 +13358,7 @@ export interface TaskProgressLine {
|
|
|
12662
13358
|
timestamp: string;
|
|
12663
13359
|
}
|
|
12664
13360
|
/**
|
|
12665
|
-
*
|
|
13361
|
+
* Tracked shell task metadata, including ID, command, status, timing, attachment/execution mode, log path, and PID.
|
|
12666
13362
|
*
|
|
12667
13363
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12668
13364
|
* via the `definition` "TaskShellInfo".
|
|
@@ -12723,7 +13419,7 @@ export interface TaskList {
|
|
|
12723
13419
|
tasks: TaskInfo[];
|
|
12724
13420
|
}
|
|
12725
13421
|
/**
|
|
12726
|
-
*
|
|
13422
|
+
* Progress snapshot for a shell task, with recent stdout/stderr output and optional process ID.
|
|
12727
13423
|
*
|
|
12728
13424
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12729
13425
|
* via the `definition` "TaskShellProgress".
|
|
@@ -12981,7 +13677,7 @@ export interface TelemetrySetFeatureOverridesRequest {
|
|
|
12981
13677
|
};
|
|
12982
13678
|
}
|
|
12983
13679
|
/**
|
|
12984
|
-
*
|
|
13680
|
+
* Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions.
|
|
12985
13681
|
*
|
|
12986
13682
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12987
13683
|
* via the `definition` "Tool".
|
|
@@ -13116,7 +13812,7 @@ export interface UIElicitationArrayAnyOfFieldItems {
|
|
|
13116
13812
|
anyOf: UIElicitationArrayAnyOfFieldItemsAnyOf[];
|
|
13117
13813
|
}
|
|
13118
13814
|
/**
|
|
13119
|
-
*
|
|
13815
|
+
* Selectable option for a UI elicitation multi-select array item, with submitted value and display label.
|
|
13120
13816
|
*
|
|
13121
13817
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13122
13818
|
* via the `definition` "UIElicitationArrayAnyOfFieldItemsAnyOf".
|
|
@@ -13283,7 +13979,7 @@ export interface UIElicitationStringOneOfField {
|
|
|
13283
13979
|
default?: string;
|
|
13284
13980
|
}
|
|
13285
13981
|
/**
|
|
13286
|
-
*
|
|
13982
|
+
* Selectable option for a UI elicitation single-select string field, with submitted value and display label.
|
|
13287
13983
|
*
|
|
13288
13984
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13289
13985
|
* via the `definition` "UIElicitationStringOneOfFieldOneOf".
|
|
@@ -13449,7 +14145,7 @@ export interface UIEphemeralQueryResult {
|
|
|
13449
14145
|
answer: string;
|
|
13450
14146
|
}
|
|
13451
14147
|
/**
|
|
13452
|
-
*
|
|
14148
|
+
* User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback.
|
|
13453
14149
|
*
|
|
13454
14150
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13455
14151
|
* via the `definition` "UIExitPlanModeResponse".
|
|
@@ -13596,7 +14292,7 @@ export interface UIHandlePendingUserInputRequest {
|
|
|
13596
14292
|
response: UIUserInputResponse;
|
|
13597
14293
|
}
|
|
13598
14294
|
/**
|
|
13599
|
-
*
|
|
14295
|
+
* User response for a pending user-input request, with answer text and whether it was typed freeform.
|
|
13600
14296
|
*
|
|
13601
14297
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13602
14298
|
* via the `definition` "UIUserInputResponse".
|
|
@@ -13719,7 +14415,7 @@ export interface UsageGetMetricsResult {
|
|
|
13719
14415
|
lastCallOutputTokens: number;
|
|
13720
14416
|
}
|
|
13721
14417
|
/**
|
|
13722
|
-
*
|
|
14418
|
+
* Session-wide token-detail entry containing the accumulated token count for one token type.
|
|
13723
14419
|
*
|
|
13724
14420
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13725
14421
|
* via the `definition` "UsageMetricsTokenDetail".
|
|
@@ -13757,7 +14453,7 @@ export interface UsageMetricsCodeChanges {
|
|
|
13757
14453
|
filesModified: string[];
|
|
13758
14454
|
}
|
|
13759
14455
|
/**
|
|
13760
|
-
*
|
|
14456
|
+
* Per-model usage metrics, including request counts/costs, token usage, nano-AI units, and per-token-type details.
|
|
13761
14457
|
*
|
|
13762
14458
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13763
14459
|
* via the `definition` "UsageMetricsModelMetric".
|
|
@@ -13824,7 +14520,7 @@ export interface UsageMetricsModelMetricUsage {
|
|
|
13824
14520
|
reasoningTokens?: number;
|
|
13825
14521
|
}
|
|
13826
14522
|
/**
|
|
13827
|
-
*
|
|
14523
|
+
* Per-model token-detail entry containing the accumulated token count for one token type.
|
|
13828
14524
|
*
|
|
13829
14525
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13830
14526
|
* via the `definition` "UsageMetricsModelMetricTokenDetail".
|
|
@@ -14029,7 +14725,7 @@ export interface WorkspaceDiffResult {
|
|
|
14029
14725
|
isFallback: boolean;
|
|
14030
14726
|
}
|
|
14031
14727
|
/**
|
|
14032
|
-
*
|
|
14728
|
+
* Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename.
|
|
14033
14729
|
*
|
|
14034
14730
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14035
14731
|
* via the `definition` "WorkspacesCheckpoints".
|
|
@@ -14550,6 +15246,15 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
14550
15246
|
getDiscoveryPaths: (params: InstructionsGetDiscoveryPathsRequest) => Promise<InstructionDiscoveryPathList>;
|
|
14551
15247
|
};
|
|
14552
15248
|
/** @experimental */
|
|
15249
|
+
commands: {
|
|
15250
|
+
/**
|
|
15251
|
+
* Lists the well-known built-in slash commands that work as the first message in a new session (e.g. /plan, /env), without requiring an active session. Commands that depend on session state, authentication, or a synced session are omitted.
|
|
15252
|
+
*
|
|
15253
|
+
* @returns Slash commands available in the session, after applying any include/exclude filters.
|
|
15254
|
+
*/
|
|
15255
|
+
list: () => Promise<CommandList>;
|
|
15256
|
+
};
|
|
15257
|
+
/** @experimental */
|
|
14553
15258
|
user: {
|
|
14554
15259
|
/** @experimental */
|
|
14555
15260
|
settings: {
|
|
@@ -14829,6 +15534,16 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
14829
15534
|
* @experimental
|
|
14830
15535
|
*/
|
|
14831
15536
|
send: (params: SendRequest) => Promise<SendResult>;
|
|
15537
|
+
/**
|
|
15538
|
+
* Sends zero or more user messages to the session in a single turn and returns their message IDs. All provided messages are appended to the conversation in order, then exactly one agent turn runs over the resulting history. When the list is empty, one turn runs over the existing history with no new user message. Remote-backed (Mission Control) sessions do not support this method and will return an error.
|
|
15539
|
+
*
|
|
15540
|
+
* @param params Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error.
|
|
15541
|
+
*
|
|
15542
|
+
* @returns Result of sending zero or more user messages
|
|
15543
|
+
*
|
|
15544
|
+
* @experimental
|
|
15545
|
+
*/
|
|
15546
|
+
sendMessages: (params: SendMessagesRequest) => Promise<SendMessagesResult>;
|
|
14832
15547
|
/**
|
|
14833
15548
|
* Aborts the current agent turn.
|
|
14834
15549
|
*
|
|
@@ -14865,6 +15580,17 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
14865
15580
|
setCredentials: (params: SessionSetCredentialsParams) => Promise<SessionSetCredentialsResult>;
|
|
14866
15581
|
};
|
|
14867
15582
|
/** @experimental */
|
|
15583
|
+
debug: {
|
|
15584
|
+
/**
|
|
15585
|
+
* Collects a redacted session debug log bundle into a local archive or staging directory. 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.
|
|
15586
|
+
*
|
|
15587
|
+
* @param params Options for collecting a redacted session debug bundle.
|
|
15588
|
+
*
|
|
15589
|
+
* @returns Result of collecting a redacted debug bundle.
|
|
15590
|
+
*/
|
|
15591
|
+
collectLogs: (params: DebugCollectLogsRequest) => Promise<DebugCollectLogsResult>;
|
|
15592
|
+
};
|
|
15593
|
+
/** @experimental */
|
|
14868
15594
|
canvas: {
|
|
14869
15595
|
/**
|
|
14870
15596
|
* Lists canvases declared for the session.
|
|
@@ -15315,6 +16041,18 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
15315
16041
|
* @returns Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove).
|
|
15316
16042
|
*/
|
|
15317
16043
|
removeGitHub: () => Promise<McpRemoveGitHubResult>;
|
|
16044
|
+
/**
|
|
16045
|
+
* Starts an individual MCP server on the live session from a caller-supplied config. Session-scoped and ephemeral: the server is added to this session's running set only and is reaped when the session ends. Does NOT modify persistent user configuration (`mcp.config.*`), so it does not affect future sessions. The server surfaces through `session.mcp.list` and the `session.mcp_servers_loaded` / `session.mcp_server_status_changed` events like any other server.
|
|
16046
|
+
*
|
|
16047
|
+
* @param params Server name and configuration for an individual MCP server start.
|
|
16048
|
+
*/
|
|
16049
|
+
startServer: (params: McpStartServerRequest) => Promise<void>;
|
|
16050
|
+
/**
|
|
16051
|
+
* Restarts an individual MCP server on the live session (stops then starts). Omit `config` for a config-free restart-by-name of an already-configured server; supply `config` to restart with a replacement configuration. Session-scoped and ephemeral: does NOT modify persistent user configuration (`mcp.config.*`).
|
|
16052
|
+
*
|
|
16053
|
+
* @param params Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server.
|
|
16054
|
+
*/
|
|
16055
|
+
restartServer: (params: McpRestartServerRequest) => Promise<void>;
|
|
15318
16056
|
/**
|
|
15319
16057
|
* Stops an individual MCP server on the session's host.
|
|
15320
16058
|
*
|
|
@@ -15703,17 +16441,17 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
15703
16441
|
*/
|
|
15704
16442
|
setApproveAll: (params: PermissionsSetApproveAllRequest) => Promise<PermissionsSetApproveAllResult>;
|
|
15705
16443
|
/**
|
|
15706
|
-
*
|
|
16444
|
+
* Sets the allow-all permission mode for the session. Used by attach-mode clients (e.g. LocalRpcSession's `/allow-all` forwarder) to flip the target session's permission state. The `on` mode swaps in unrestricted path and URL managers and emits `session.permissions_changed` on transition; the `auto` mode keeps normal prompt paths active while attaching LLM safety recommendations. The result returns the authoritative post-mutation state so callers can update their local mirrors without racing the `session.permissions_changed` notification on the same wire.
|
|
15707
16445
|
*
|
|
15708
|
-
* @param params
|
|
16446
|
+
* @param params Allow-all mode to apply for the session.
|
|
15709
16447
|
*
|
|
15710
16448
|
* @returns Indicates whether the operation succeeded and reports the post-mutation state.
|
|
15711
16449
|
*/
|
|
15712
16450
|
setAllowAll: (params: PermissionsSetAllowAllRequest) => Promise<AllowAllPermissionSetResult>;
|
|
15713
16451
|
/**
|
|
15714
|
-
* Returns
|
|
16452
|
+
* Returns the current allow-all permission mode for the session.
|
|
15715
16453
|
*
|
|
15716
|
-
* @returns Current
|
|
16454
|
+
* @returns Current allow-all permission mode.
|
|
15717
16455
|
*/
|
|
15718
16456
|
getAllowAll: () => Promise<AllowAllPermissionState>;
|
|
15719
16457
|
/**
|
|
@@ -16288,9 +17026,9 @@ export interface LlmInferenceHandler {
|
|
|
16288
17026
|
/** @experimental */
|
|
16289
17027
|
export interface GitHubTelemetryHandler {
|
|
16290
17028
|
/**
|
|
16291
|
-
* Forwards a single GitHub telemetry event to a host connection that opted into telemetry forwarding
|
|
17029
|
+
* Forwards a single GitHub telemetry event to a host connection that opted into telemetry forwarding during the `server.connect` handshake. Opted-in connections receive every event the runtime emits after the handshake — across all sessions, plus sessionless events (for example, `server.sendTelemetry` calls with no session id).
|
|
16292
17030
|
*
|
|
16293
|
-
* @param params Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding
|
|
17031
|
+
* @param params Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake.
|
|
16294
17032
|
*/
|
|
16295
17033
|
event(params: GitHubTelemetryNotification): Promise<void>;
|
|
16296
17034
|
}
|