@github/copilot-sdk 1.0.5-preview.0 → 1.0.5-preview.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/client.js +16 -2
- package/dist/cjs/generated/rpc.js +48 -3
- package/dist/cjs/session.js +40 -1
- package/dist/client.js +16 -2
- package/dist/generated/rpc.d.ts +290 -7
- package/dist/generated/rpc.js +48 -3
- package/dist/generated/session-events.d.ts +77 -12
- package/dist/session.d.ts +1 -0
- package/dist/session.js +40 -1
- package/dist/types.d.ts +68 -0
- package/package.json +2 -2
package/dist/generated/rpc.d.ts
CHANGED
|
@@ -3,13 +3,14 @@
|
|
|
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,
|
|
6
|
+
import type { AbortReason, Attachment, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpServerSource, McpServerStatus, PermissionPromptRequest, PermissionRule, ReasoningSummary, ResponseLimitsConfig, SessionEvent, SessionMode, ShutdownType, SkillSource, UserToolSessionApproval } from "./session-events.js";
|
|
7
7
|
/**
|
|
8
8
|
* Initial authentication info for the session.
|
|
9
9
|
*
|
|
10
10
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11
11
|
* via the `definition` "AuthInfo".
|
|
12
12
|
*/
|
|
13
|
+
/** @experimental */
|
|
13
14
|
export type AuthInfo = HMACAuthInfo | EnvAuthInfo | TokenAuthInfo | CopilotApiTokenAuthInfo | UserAuthInfo | GhCliAuthInfo | ApiKeyAuthInfo;
|
|
14
15
|
/**
|
|
15
16
|
* Which tier this directory belongs to
|
|
@@ -243,6 +244,7 @@ export type ConnectedRemoteSessionMetadataKind =
|
|
|
243
244
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
244
245
|
* via the `definition` "ContentFilterMode".
|
|
245
246
|
*/
|
|
247
|
+
/** @experimental */
|
|
246
248
|
export type ContentFilterMode =
|
|
247
249
|
/** Leave MCP tool result content unchanged. */
|
|
248
250
|
"none"
|
|
@@ -256,6 +258,7 @@ export type ContentFilterMode =
|
|
|
256
258
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
257
259
|
* via the `definition` "DiscoveredMcpServerType".
|
|
258
260
|
*/
|
|
261
|
+
/** @experimental */
|
|
259
262
|
export type DiscoveredMcpServerType =
|
|
260
263
|
/** Server communicates over stdio with a local child process. */
|
|
261
264
|
"stdio"
|
|
@@ -356,7 +359,7 @@ export type ExternalToolTextResultForLlmBinaryResultsForLlmType =
|
|
|
356
359
|
* via the `definition` "ExternalToolTextResultForLlmContent".
|
|
357
360
|
*/
|
|
358
361
|
/** @experimental */
|
|
359
|
-
export type ExternalToolTextResultForLlmContent = ExternalToolTextResultForLlmContentText | ExternalToolTextResultForLlmContentTerminal | ExternalToolTextResultForLlmContentImage | ExternalToolTextResultForLlmContentAudio | ExternalToolTextResultForLlmContentResourceLink | ExternalToolTextResultForLlmContentResource;
|
|
362
|
+
export type ExternalToolTextResultForLlmContent = ExternalToolTextResultForLlmContentText | ExternalToolTextResultForLlmContentTerminal | ExternalToolTextResultForLlmContentShellExit | ExternalToolTextResultForLlmContentImage | ExternalToolTextResultForLlmContentAudio | ExternalToolTextResultForLlmContentResourceLink | ExternalToolTextResultForLlmContentResource;
|
|
360
363
|
/**
|
|
361
364
|
* Theme variant this icon is intended for
|
|
362
365
|
*
|
|
@@ -383,6 +386,7 @@ export type ExternalToolTextResultForLlmContentResourceDetails = EmbeddedTextRes
|
|
|
383
386
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
384
387
|
* via the `definition` "FilterMapping".
|
|
385
388
|
*/
|
|
389
|
+
/** @experimental */
|
|
386
390
|
export type FilterMapping = {
|
|
387
391
|
[k: string]: ContentFilterMode;
|
|
388
392
|
} | ContentFilterMode;
|
|
@@ -612,6 +616,7 @@ export type McpAppsSetHostContextDetailsPlatform =
|
|
|
612
616
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
613
617
|
* via the `definition` "McpServerConfig".
|
|
614
618
|
*/
|
|
619
|
+
/** @experimental */
|
|
615
620
|
export type McpServerConfig = McpServerConfigStdio | McpServerConfigHttp;
|
|
616
621
|
/**
|
|
617
622
|
* Set to `true` to use defaults, or provide an object with additional auth or OIDC settings.
|
|
@@ -619,6 +624,7 @@ export type McpServerConfig = McpServerConfigStdio | McpServerConfigHttp;
|
|
|
619
624
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
620
625
|
* via the `definition` "McpServerAuthConfig".
|
|
621
626
|
*/
|
|
627
|
+
/** @experimental */
|
|
622
628
|
export type McpServerAuthConfig = boolean | McpServerAuthConfigRedirectPort;
|
|
623
629
|
/**
|
|
624
630
|
* Controls if tools provided by this server can be loaded on demand via tool search (auto) or always included in the initial tool list (never)
|
|
@@ -626,6 +632,7 @@ export type McpServerAuthConfig = boolean | McpServerAuthConfigRedirectPort;
|
|
|
626
632
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
627
633
|
* via the `definition` "McpServerConfigDeferTools".
|
|
628
634
|
*/
|
|
635
|
+
/** @experimental */
|
|
629
636
|
export type McpServerConfigDeferTools =
|
|
630
637
|
/** Tools may be deferred under certain conditions */
|
|
631
638
|
"auto"
|
|
@@ -637,6 +644,7 @@ export type McpServerConfigDeferTools =
|
|
|
637
644
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
638
645
|
* via the `definition` "McpServerConfigHttpType".
|
|
639
646
|
*/
|
|
647
|
+
/** @experimental */
|
|
640
648
|
export type McpServerConfigHttpType =
|
|
641
649
|
/** Streamable HTTP transport. */
|
|
642
650
|
"http"
|
|
@@ -648,6 +656,7 @@ export type McpServerConfigHttpType =
|
|
|
648
656
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
649
657
|
* via the `definition` "McpServerConfigHttpOauthGrantType".
|
|
650
658
|
*/
|
|
659
|
+
/** @experimental */
|
|
651
660
|
export type McpServerConfigHttpOauthGrantType =
|
|
652
661
|
/** Interactive browser-based authorization code flow with PKCE. */
|
|
653
662
|
"authorization_code"
|
|
@@ -826,6 +835,7 @@ export type MetadataSnapshotRemoteMetadataTaskType =
|
|
|
826
835
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
827
836
|
* via the `definition` "ModelPolicyState".
|
|
828
837
|
*/
|
|
838
|
+
/** @experimental */
|
|
829
839
|
export type ModelPolicyState =
|
|
830
840
|
/** The model is enabled by policy. */
|
|
831
841
|
"enabled"
|
|
@@ -839,6 +849,7 @@ export type ModelPolicyState =
|
|
|
839
849
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
840
850
|
* via the `definition` "ModelPickerCategory".
|
|
841
851
|
*/
|
|
852
|
+
/** @experimental */
|
|
842
853
|
export type ModelPickerCategory =
|
|
843
854
|
/** Lightweight model category optimized for faster, lower-cost interactions. */
|
|
844
855
|
"lightweight"
|
|
@@ -852,6 +863,7 @@ export type ModelPickerCategory =
|
|
|
852
863
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
853
864
|
* via the `definition` "ModelPickerPriceCategory".
|
|
854
865
|
*/
|
|
866
|
+
/** @experimental */
|
|
855
867
|
export type ModelPickerPriceCategory =
|
|
856
868
|
/** Lowest relative token cost tier. */
|
|
857
869
|
"low"
|
|
@@ -1255,6 +1267,7 @@ export type SessionFsReaddirWithTypesEntryType =
|
|
|
1255
1267
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1256
1268
|
* via the `definition` "SessionFsSetProviderConventions".
|
|
1257
1269
|
*/
|
|
1270
|
+
/** @experimental */
|
|
1258
1271
|
export type SessionFsSetProviderConventions =
|
|
1259
1272
|
/** Paths use Windows path conventions. */
|
|
1260
1273
|
"windows"
|
|
@@ -1470,6 +1483,18 @@ export type SessionSource =
|
|
|
1470
1483
|
| "remote"
|
|
1471
1484
|
/** Return both local and remote sessions. */
|
|
1472
1485
|
| "all";
|
|
1486
|
+
/**
|
|
1487
|
+
* Sharing status for a synced session. "repo" makes the session visible to anyone with read access to the repository; "unshared" restricts it to the creator and collaborators.
|
|
1488
|
+
*
|
|
1489
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1490
|
+
* via the `definition` "SessionVisibilityStatus".
|
|
1491
|
+
*/
|
|
1492
|
+
/** @experimental */
|
|
1493
|
+
export type SessionVisibilityStatus =
|
|
1494
|
+
/** The session is visible to repository readers. */
|
|
1495
|
+
"repo"
|
|
1496
|
+
/** The session is restricted to its creator and collaborators. */
|
|
1497
|
+
| "unshared";
|
|
1473
1498
|
/**
|
|
1474
1499
|
* Signal to send (default: SIGTERM)
|
|
1475
1500
|
*
|
|
@@ -1743,6 +1768,7 @@ export type WorkspacesWorkspaceDetailsHostType =
|
|
|
1743
1768
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1744
1769
|
* via the `definition` "AccountGetAllUsersResult".
|
|
1745
1770
|
*/
|
|
1771
|
+
/** @experimental */
|
|
1746
1772
|
export type AccountGetAllUsersResult = AccountAllUsers[];
|
|
1747
1773
|
/**
|
|
1748
1774
|
* Parameters for aborting the current turn
|
|
@@ -1777,6 +1803,7 @@ export interface AbortResult {
|
|
|
1777
1803
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1778
1804
|
* via the `definition` "AccountAllUsers".
|
|
1779
1805
|
*/
|
|
1806
|
+
/** @experimental */
|
|
1780
1807
|
export interface AccountAllUsers {
|
|
1781
1808
|
authInfo: AuthInfo;
|
|
1782
1809
|
/**
|
|
@@ -1790,6 +1817,7 @@ export interface AccountAllUsers {
|
|
|
1790
1817
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1791
1818
|
* via the `definition` "HMACAuthInfo".
|
|
1792
1819
|
*/
|
|
1820
|
+
/** @experimental */
|
|
1793
1821
|
export interface HMACAuthInfo {
|
|
1794
1822
|
/**
|
|
1795
1823
|
* HMAC-based authentication used by GitHub-internal services.
|
|
@@ -1811,6 +1839,7 @@ export interface HMACAuthInfo {
|
|
|
1811
1839
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1812
1840
|
* via the `definition` "CopilotUserResponse".
|
|
1813
1841
|
*/
|
|
1842
|
+
/** @experimental */
|
|
1814
1843
|
export interface CopilotUserResponse {
|
|
1815
1844
|
login?: string;
|
|
1816
1845
|
access_type_sku?: string;
|
|
@@ -1861,6 +1890,7 @@ export interface CopilotUserResponse {
|
|
|
1861
1890
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1862
1891
|
* via the `definition` "CopilotUserResponseEndpoints".
|
|
1863
1892
|
*/
|
|
1893
|
+
/** @experimental */
|
|
1864
1894
|
export interface CopilotUserResponseEndpoints {
|
|
1865
1895
|
api?: string;
|
|
1866
1896
|
"origin-tracker"?: string;
|
|
@@ -1873,6 +1903,7 @@ export interface CopilotUserResponseEndpoints {
|
|
|
1873
1903
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1874
1904
|
* via the `definition` "CopilotUserResponseQuotaSnapshots".
|
|
1875
1905
|
*/
|
|
1906
|
+
/** @experimental */
|
|
1876
1907
|
export interface CopilotUserResponseQuotaSnapshots {
|
|
1877
1908
|
chat?: CopilotUserResponseQuotaSnapshotsChat;
|
|
1878
1909
|
completions?: CopilotUserResponseQuotaSnapshotsCompletions;
|
|
@@ -1898,6 +1929,7 @@ export interface CopilotUserResponseQuotaSnapshots {
|
|
|
1898
1929
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1899
1930
|
* via the `definition` "CopilotUserResponseQuotaSnapshotsChat".
|
|
1900
1931
|
*/
|
|
1932
|
+
/** @experimental */
|
|
1901
1933
|
export interface CopilotUserResponseQuotaSnapshotsChat {
|
|
1902
1934
|
entitlement?: number;
|
|
1903
1935
|
overage_count?: number;
|
|
@@ -1918,6 +1950,7 @@ export interface CopilotUserResponseQuotaSnapshotsChat {
|
|
|
1918
1950
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1919
1951
|
* via the `definition` "CopilotUserResponseQuotaSnapshotsCompletions".
|
|
1920
1952
|
*/
|
|
1953
|
+
/** @experimental */
|
|
1921
1954
|
export interface CopilotUserResponseQuotaSnapshotsCompletions {
|
|
1922
1955
|
entitlement?: number;
|
|
1923
1956
|
overage_count?: number;
|
|
@@ -1938,6 +1971,7 @@ export interface CopilotUserResponseQuotaSnapshotsCompletions {
|
|
|
1938
1971
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1939
1972
|
* via the `definition` "CopilotUserResponseQuotaSnapshotsPremiumInteractions".
|
|
1940
1973
|
*/
|
|
1974
|
+
/** @experimental */
|
|
1941
1975
|
export interface CopilotUserResponseQuotaSnapshotsPremiumInteractions {
|
|
1942
1976
|
entitlement?: number;
|
|
1943
1977
|
overage_count?: number;
|
|
@@ -1958,6 +1992,7 @@ export interface CopilotUserResponseQuotaSnapshotsPremiumInteractions {
|
|
|
1958
1992
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1959
1993
|
* via the `definition` "EnvAuthInfo".
|
|
1960
1994
|
*/
|
|
1995
|
+
/** @experimental */
|
|
1961
1996
|
export interface EnvAuthInfo {
|
|
1962
1997
|
/**
|
|
1963
1998
|
* Personal access token (PAT) or server-to-server token sourced from an environment variable.
|
|
@@ -1987,6 +2022,7 @@ export interface EnvAuthInfo {
|
|
|
1987
2022
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1988
2023
|
* via the `definition` "TokenAuthInfo".
|
|
1989
2024
|
*/
|
|
2025
|
+
/** @experimental */
|
|
1990
2026
|
export interface TokenAuthInfo {
|
|
1991
2027
|
/**
|
|
1992
2028
|
* SDK-side token authentication; the host configured the token directly via the SDK.
|
|
@@ -2008,6 +2044,7 @@ export interface TokenAuthInfo {
|
|
|
2008
2044
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2009
2045
|
* via the `definition` "CopilotApiTokenAuthInfo".
|
|
2010
2046
|
*/
|
|
2047
|
+
/** @experimental */
|
|
2011
2048
|
export interface CopilotApiTokenAuthInfo {
|
|
2012
2049
|
/**
|
|
2013
2050
|
* Direct Copilot API authentication via the `GITHUB_COPILOT_API_TOKEN` + `COPILOT_API_URL` environment-variable pair. The token itself is read from the environment by the runtime, not carried in this struct.
|
|
@@ -2025,6 +2062,7 @@ export interface CopilotApiTokenAuthInfo {
|
|
|
2025
2062
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2026
2063
|
* via the `definition` "UserAuthInfo".
|
|
2027
2064
|
*/
|
|
2065
|
+
/** @experimental */
|
|
2028
2066
|
export interface UserAuthInfo {
|
|
2029
2067
|
/**
|
|
2030
2068
|
* OAuth user authentication. The token itself is held in the runtime's secret token store (keyed by host+login) and is NOT carried in this struct.
|
|
@@ -2046,6 +2084,7 @@ export interface UserAuthInfo {
|
|
|
2046
2084
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2047
2085
|
* via the `definition` "GhCliAuthInfo".
|
|
2048
2086
|
*/
|
|
2087
|
+
/** @experimental */
|
|
2049
2088
|
export interface GhCliAuthInfo {
|
|
2050
2089
|
/**
|
|
2051
2090
|
* Authentication via the `gh` CLI's saved credentials.
|
|
@@ -2071,6 +2110,7 @@ export interface GhCliAuthInfo {
|
|
|
2071
2110
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2072
2111
|
* via the `definition` "ApiKeyAuthInfo".
|
|
2073
2112
|
*/
|
|
2113
|
+
/** @experimental */
|
|
2074
2114
|
export interface ApiKeyAuthInfo {
|
|
2075
2115
|
/**
|
|
2076
2116
|
* API-key authentication for non-GitHub LLM providers (e.g. when running BYOM-style).
|
|
@@ -2092,6 +2132,7 @@ export interface ApiKeyAuthInfo {
|
|
|
2092
2132
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2093
2133
|
* via the `definition` "AccountGetCurrentAuthResult".
|
|
2094
2134
|
*/
|
|
2135
|
+
/** @experimental */
|
|
2095
2136
|
export interface AccountGetCurrentAuthResult {
|
|
2096
2137
|
authInfo?: AuthInfo;
|
|
2097
2138
|
/**
|
|
@@ -2099,6 +2140,7 @@ export interface AccountGetCurrentAuthResult {
|
|
|
2099
2140
|
*/
|
|
2100
2141
|
authErrors?: string[];
|
|
2101
2142
|
}
|
|
2143
|
+
/** @experimental */
|
|
2102
2144
|
export interface AccountGetQuotaRequest {
|
|
2103
2145
|
/**
|
|
2104
2146
|
* GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth.
|
|
@@ -2111,6 +2153,7 @@ export interface AccountGetQuotaRequest {
|
|
|
2111
2153
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2112
2154
|
* via the `definition` "AccountGetQuotaResult".
|
|
2113
2155
|
*/
|
|
2156
|
+
/** @experimental */
|
|
2114
2157
|
export interface AccountGetQuotaResult {
|
|
2115
2158
|
/**
|
|
2116
2159
|
* Quota snapshots keyed by type (e.g., chat, completions, premium_interactions)
|
|
@@ -2125,6 +2168,7 @@ export interface AccountGetQuotaResult {
|
|
|
2125
2168
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2126
2169
|
* via the `definition` "AccountQuotaSnapshot".
|
|
2127
2170
|
*/
|
|
2171
|
+
/** @experimental */
|
|
2128
2172
|
export interface AccountQuotaSnapshot {
|
|
2129
2173
|
/**
|
|
2130
2174
|
* Whether the user has an unlimited usage entitlement
|
|
@@ -2165,6 +2209,7 @@ export interface AccountQuotaSnapshot {
|
|
|
2165
2209
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2166
2210
|
* via the `definition` "AccountLoginRequest".
|
|
2167
2211
|
*/
|
|
2212
|
+
/** @experimental */
|
|
2168
2213
|
export interface AccountLoginRequest {
|
|
2169
2214
|
/**
|
|
2170
2215
|
* GitHub host URL
|
|
@@ -2185,6 +2230,7 @@ export interface AccountLoginRequest {
|
|
|
2185
2230
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2186
2231
|
* via the `definition` "AccountLoginResult".
|
|
2187
2232
|
*/
|
|
2233
|
+
/** @experimental */
|
|
2188
2234
|
export interface AccountLoginResult {
|
|
2189
2235
|
/**
|
|
2190
2236
|
* Whether the credential was persisted to a secure store (system keychain, or the config file when plaintext storage is enabled). False when no secure store was available and the token was not saved, so the consumer can decide how to proceed.
|
|
@@ -2197,6 +2243,7 @@ export interface AccountLoginResult {
|
|
|
2197
2243
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2198
2244
|
* via the `definition` "AccountLogoutRequest".
|
|
2199
2245
|
*/
|
|
2246
|
+
/** @experimental */
|
|
2200
2247
|
export interface AccountLogoutRequest {
|
|
2201
2248
|
authInfo: AuthInfo;
|
|
2202
2249
|
}
|
|
@@ -2206,6 +2253,7 @@ export interface AccountLogoutRequest {
|
|
|
2206
2253
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
2207
2254
|
* via the `definition` "AccountLogoutResult".
|
|
2208
2255
|
*/
|
|
2256
|
+
/** @experimental */
|
|
2209
2257
|
export interface AccountLogoutResult {
|
|
2210
2258
|
/**
|
|
2211
2259
|
* Whether other authenticated users remain after logout
|
|
@@ -3348,6 +3396,7 @@ export interface CurrentToolMetadata {
|
|
|
3348
3396
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3349
3397
|
* via the `definition` "DiscoveredMcpServer".
|
|
3350
3398
|
*/
|
|
3399
|
+
/** @experimental */
|
|
3351
3400
|
export interface DiscoveredMcpServer {
|
|
3352
3401
|
/**
|
|
3353
3402
|
* Server name (config key)
|
|
@@ -3689,6 +3738,39 @@ export interface ExternalToolTextResultForLlmContentTerminal {
|
|
|
3689
3738
|
*/
|
|
3690
3739
|
cwd?: string;
|
|
3691
3740
|
}
|
|
3741
|
+
/**
|
|
3742
|
+
* Shell command exit metadata with optional output preview
|
|
3743
|
+
*
|
|
3744
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3745
|
+
* via the `definition` "ExternalToolTextResultForLlmContentShellExit".
|
|
3746
|
+
*/
|
|
3747
|
+
/** @experimental */
|
|
3748
|
+
export interface ExternalToolTextResultForLlmContentShellExit {
|
|
3749
|
+
/**
|
|
3750
|
+
* Content block type discriminator
|
|
3751
|
+
*/
|
|
3752
|
+
type: "shell_exit";
|
|
3753
|
+
/**
|
|
3754
|
+
* Shell id, as assigned by Copilot runtime
|
|
3755
|
+
*/
|
|
3756
|
+
shellId: string;
|
|
3757
|
+
/**
|
|
3758
|
+
* Exit code from the completed shell command
|
|
3759
|
+
*/
|
|
3760
|
+
exitCode: number;
|
|
3761
|
+
/**
|
|
3762
|
+
* Working directory where the shell command was executed
|
|
3763
|
+
*/
|
|
3764
|
+
cwd?: string;
|
|
3765
|
+
/**
|
|
3766
|
+
* Output associated with this shell command, if available. May be partial, truncated, or a preview; not guaranteed to be full output.
|
|
3767
|
+
*/
|
|
3768
|
+
outputPreview?: string;
|
|
3769
|
+
/**
|
|
3770
|
+
* Whether outputPreview is known to be incomplete or truncated
|
|
3771
|
+
*/
|
|
3772
|
+
outputTruncated?: boolean;
|
|
3773
|
+
}
|
|
3692
3774
|
/**
|
|
3693
3775
|
* Image content block with base64-encoded data
|
|
3694
3776
|
*
|
|
@@ -5049,6 +5131,7 @@ export interface McpCancelSamplingExecutionResult {
|
|
|
5049
5131
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5050
5132
|
* via the `definition` "McpConfigAddRequest".
|
|
5051
5133
|
*/
|
|
5134
|
+
/** @experimental */
|
|
5052
5135
|
export interface McpConfigAddRequest {
|
|
5053
5136
|
/**
|
|
5054
5137
|
* Unique name for the MCP server
|
|
@@ -5062,6 +5145,7 @@ export interface McpConfigAddRequest {
|
|
|
5062
5145
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5063
5146
|
* via the `definition` "McpServerConfigStdio".
|
|
5064
5147
|
*/
|
|
5148
|
+
/** @experimental */
|
|
5065
5149
|
export interface McpServerConfigStdio {
|
|
5066
5150
|
/**
|
|
5067
5151
|
* Tools to include. Defaults to all tools if not specified.
|
|
@@ -5104,6 +5188,7 @@ export interface McpServerConfigStdio {
|
|
|
5104
5188
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5105
5189
|
* via the `definition` "McpServerAuthConfigRedirectPort".
|
|
5106
5190
|
*/
|
|
5191
|
+
/** @experimental */
|
|
5107
5192
|
export interface McpServerAuthConfigRedirectPort {
|
|
5108
5193
|
/**
|
|
5109
5194
|
* Fixed port for the OAuth redirect callback server.
|
|
@@ -5116,6 +5201,7 @@ export interface McpServerAuthConfigRedirectPort {
|
|
|
5116
5201
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5117
5202
|
* via the `definition` "McpServerConfigHttp".
|
|
5118
5203
|
*/
|
|
5204
|
+
/** @experimental */
|
|
5119
5205
|
export interface McpServerConfigHttp {
|
|
5120
5206
|
/**
|
|
5121
5207
|
* Tools to include. Defaults to all tools if not specified.
|
|
@@ -5160,6 +5246,7 @@ export interface McpServerConfigHttp {
|
|
|
5160
5246
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5161
5247
|
* via the `definition` "McpConfigDisableRequest".
|
|
5162
5248
|
*/
|
|
5249
|
+
/** @experimental */
|
|
5163
5250
|
export interface McpConfigDisableRequest {
|
|
5164
5251
|
/**
|
|
5165
5252
|
* Names of MCP servers to disable. Each server is added to the persisted disabled list so new sessions skip it. Already-disabled names are ignored. Active sessions keep their current connections until they end.
|
|
@@ -5172,6 +5259,7 @@ export interface McpConfigDisableRequest {
|
|
|
5172
5259
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5173
5260
|
* via the `definition` "McpConfigEnableRequest".
|
|
5174
5261
|
*/
|
|
5262
|
+
/** @experimental */
|
|
5175
5263
|
export interface McpConfigEnableRequest {
|
|
5176
5264
|
/**
|
|
5177
5265
|
* Names of MCP servers to enable. Each server is removed from the persisted disabled list so new sessions spawn it. Unknown or already-enabled names are ignored.
|
|
@@ -5184,6 +5272,7 @@ export interface McpConfigEnableRequest {
|
|
|
5184
5272
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5185
5273
|
* via the `definition` "McpConfigList".
|
|
5186
5274
|
*/
|
|
5275
|
+
/** @experimental */
|
|
5187
5276
|
export interface McpConfigList {
|
|
5188
5277
|
/**
|
|
5189
5278
|
* All MCP servers from user config, keyed by name
|
|
@@ -5198,6 +5287,7 @@ export interface McpConfigList {
|
|
|
5198
5287
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5199
5288
|
* via the `definition` "McpConfigRemoveRequest".
|
|
5200
5289
|
*/
|
|
5290
|
+
/** @experimental */
|
|
5201
5291
|
export interface McpConfigRemoveRequest {
|
|
5202
5292
|
/**
|
|
5203
5293
|
* Name of the MCP server to remove
|
|
@@ -5210,6 +5300,7 @@ export interface McpConfigRemoveRequest {
|
|
|
5210
5300
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5211
5301
|
* via the `definition` "McpConfigUpdateRequest".
|
|
5212
5302
|
*/
|
|
5303
|
+
/** @experimental */
|
|
5213
5304
|
export interface McpConfigUpdateRequest {
|
|
5214
5305
|
/**
|
|
5215
5306
|
* Name of the MCP server to update
|
|
@@ -5249,6 +5340,7 @@ export interface McpDisableRequest {
|
|
|
5249
5340
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5250
5341
|
* via the `definition` "McpDiscoverRequest".
|
|
5251
5342
|
*/
|
|
5343
|
+
/** @experimental */
|
|
5252
5344
|
export interface McpDiscoverRequest {
|
|
5253
5345
|
/**
|
|
5254
5346
|
* Working directory used as context for discovery (e.g., plugin resolution)
|
|
@@ -5261,6 +5353,7 @@ export interface McpDiscoverRequest {
|
|
|
5261
5353
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5262
5354
|
* via the `definition` "McpDiscoverResult".
|
|
5263
5355
|
*/
|
|
5356
|
+
/** @experimental */
|
|
5264
5357
|
export interface McpDiscoverResult {
|
|
5265
5358
|
/**
|
|
5266
5359
|
* MCP servers discovered from all sources
|
|
@@ -5945,6 +6038,7 @@ export interface MetadataSnapshotRemoteMetadataRepository {
|
|
|
5945
6038
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5946
6039
|
* via the `definition` "Model".
|
|
5947
6040
|
*/
|
|
6041
|
+
/** @experimental */
|
|
5948
6042
|
export interface Model {
|
|
5949
6043
|
/**
|
|
5950
6044
|
* Model identifier (e.g., "claude-sonnet-4.5")
|
|
@@ -5974,6 +6068,7 @@ export interface Model {
|
|
|
5974
6068
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5975
6069
|
* via the `definition` "ModelCapabilities".
|
|
5976
6070
|
*/
|
|
6071
|
+
/** @experimental */
|
|
5977
6072
|
export interface ModelCapabilities {
|
|
5978
6073
|
supports?: ModelCapabilitiesSupports;
|
|
5979
6074
|
limits?: ModelCapabilitiesLimits;
|
|
@@ -5984,6 +6079,7 @@ export interface ModelCapabilities {
|
|
|
5984
6079
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5985
6080
|
* via the `definition` "ModelCapabilitiesSupports".
|
|
5986
6081
|
*/
|
|
6082
|
+
/** @experimental */
|
|
5987
6083
|
export interface ModelCapabilitiesSupports {
|
|
5988
6084
|
/**
|
|
5989
6085
|
* Whether this model supports vision/image input
|
|
@@ -6000,6 +6096,7 @@ export interface ModelCapabilitiesSupports {
|
|
|
6000
6096
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6001
6097
|
* via the `definition` "ModelCapabilitiesLimits".
|
|
6002
6098
|
*/
|
|
6099
|
+
/** @experimental */
|
|
6003
6100
|
export interface ModelCapabilitiesLimits {
|
|
6004
6101
|
/**
|
|
6005
6102
|
* Maximum number of prompt/input tokens
|
|
@@ -6021,6 +6118,7 @@ export interface ModelCapabilitiesLimits {
|
|
|
6021
6118
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6022
6119
|
* via the `definition` "ModelCapabilitiesLimitsVision".
|
|
6023
6120
|
*/
|
|
6121
|
+
/** @experimental */
|
|
6024
6122
|
export interface ModelCapabilitiesLimitsVision {
|
|
6025
6123
|
/**
|
|
6026
6124
|
* MIME types the model accepts
|
|
@@ -6041,6 +6139,7 @@ export interface ModelCapabilitiesLimitsVision {
|
|
|
6041
6139
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6042
6140
|
* via the `definition` "ModelPolicy".
|
|
6043
6141
|
*/
|
|
6142
|
+
/** @experimental */
|
|
6044
6143
|
export interface ModelPolicy {
|
|
6045
6144
|
state: ModelPolicyState;
|
|
6046
6145
|
/**
|
|
@@ -6054,6 +6153,7 @@ export interface ModelPolicy {
|
|
|
6054
6153
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6055
6154
|
* via the `definition` "ModelBilling".
|
|
6056
6155
|
*/
|
|
6156
|
+
/** @experimental */
|
|
6057
6157
|
export interface ModelBilling {
|
|
6058
6158
|
/**
|
|
6059
6159
|
* Billing cost multiplier relative to the base rate
|
|
@@ -6071,6 +6171,7 @@ export interface ModelBilling {
|
|
|
6071
6171
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6072
6172
|
* via the `definition` "ModelBillingTokenPrices".
|
|
6073
6173
|
*/
|
|
6174
|
+
/** @experimental */
|
|
6074
6175
|
export interface ModelBillingTokenPrices {
|
|
6075
6176
|
/**
|
|
6076
6177
|
* AI Credits cost per billing batch of input tokens
|
|
@@ -6114,6 +6215,7 @@ export interface ModelBillingTokenPrices {
|
|
|
6114
6215
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6115
6216
|
* via the `definition` "ModelBillingTokenPricesLongContext".
|
|
6116
6217
|
*/
|
|
6218
|
+
/** @experimental */
|
|
6117
6219
|
export interface ModelBillingTokenPricesLongContext {
|
|
6118
6220
|
/**
|
|
6119
6221
|
* AI Credits cost per billing batch of input tokens
|
|
@@ -6223,6 +6325,7 @@ export interface ModelCapabilitiesOverrideLimitsVision {
|
|
|
6223
6325
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6224
6326
|
* via the `definition` "ModelList".
|
|
6225
6327
|
*/
|
|
6328
|
+
/** @experimental */
|
|
6226
6329
|
export interface ModelList {
|
|
6227
6330
|
/**
|
|
6228
6331
|
* List of available models with full metadata
|
|
@@ -6268,6 +6371,7 @@ export interface ModelSetReasoningEffortResult {
|
|
|
6268
6371
|
*/
|
|
6269
6372
|
reasoningEffort: string;
|
|
6270
6373
|
}
|
|
6374
|
+
/** @experimental */
|
|
6271
6375
|
export interface ModelsListRequest {
|
|
6272
6376
|
/**
|
|
6273
6377
|
* GitHub token for per-user model listing. When provided, resolves this token to determine the user's Copilot plan and available models instead of using the global auth.
|
|
@@ -7540,6 +7644,7 @@ export interface PermissionsFolderTrustAddTrustedResult {
|
|
|
7540
7644
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7541
7645
|
* via the `definition` "PermissionsGetAllowAllRequest".
|
|
7542
7646
|
*/
|
|
7647
|
+
/** @experimental */
|
|
7543
7648
|
export interface PermissionsGetAllowAllRequest {
|
|
7544
7649
|
}
|
|
7545
7650
|
/**
|
|
@@ -7622,6 +7727,7 @@ export interface PermissionsPathsAddResult {
|
|
|
7622
7727
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7623
7728
|
* via the `definition` "PermissionsPathsListRequest".
|
|
7624
7729
|
*/
|
|
7730
|
+
/** @experimental */
|
|
7625
7731
|
export interface PermissionsPathsListRequest {
|
|
7626
7732
|
}
|
|
7627
7733
|
/**
|
|
@@ -7643,6 +7749,7 @@ export interface PermissionsPathsUpdatePrimaryResult {
|
|
|
7643
7749
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7644
7750
|
* via the `definition` "PermissionsPendingRequestsRequest".
|
|
7645
7751
|
*/
|
|
7752
|
+
/** @experimental */
|
|
7646
7753
|
export interface PermissionsPendingRequestsRequest {
|
|
7647
7754
|
}
|
|
7648
7755
|
/**
|
|
@@ -7651,6 +7758,7 @@ export interface PermissionsPendingRequestsRequest {
|
|
|
7651
7758
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7652
7759
|
* via the `definition` "PermissionsResetSessionApprovalsRequest".
|
|
7653
7760
|
*/
|
|
7761
|
+
/** @experimental */
|
|
7654
7762
|
export interface PermissionsResetSessionApprovalsRequest {
|
|
7655
7763
|
}
|
|
7656
7764
|
/**
|
|
@@ -7765,6 +7873,7 @@ export interface PermissionUrlsSetUnrestrictedModeParams {
|
|
|
7765
7873
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7766
7874
|
* via the `definition` "PingRequest".
|
|
7767
7875
|
*/
|
|
7876
|
+
/** @experimental */
|
|
7768
7877
|
export interface PingRequest {
|
|
7769
7878
|
/**
|
|
7770
7879
|
* Optional message to echo back
|
|
@@ -7777,6 +7886,7 @@ export interface PingRequest {
|
|
|
7777
7886
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7778
7887
|
* via the `definition` "PingResult".
|
|
7779
7888
|
*/
|
|
7889
|
+
/** @experimental */
|
|
7780
7890
|
export interface PingResult {
|
|
7781
7891
|
/**
|
|
7782
7892
|
* Echoed message (or default greeting)
|
|
@@ -9522,6 +9632,7 @@ export interface ScheduleStopResult {
|
|
|
9522
9632
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9523
9633
|
* via the `definition` "SecretsAddFilterValuesRequest".
|
|
9524
9634
|
*/
|
|
9635
|
+
/** @experimental */
|
|
9525
9636
|
export interface SecretsAddFilterValuesRequest {
|
|
9526
9637
|
/**
|
|
9527
9638
|
* Raw secret values to register for redaction
|
|
@@ -9534,6 +9645,7 @@ export interface SecretsAddFilterValuesRequest {
|
|
|
9534
9645
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9535
9646
|
* via the `definition` "SecretsAddFilterValuesResult".
|
|
9536
9647
|
*/
|
|
9648
|
+
/** @experimental */
|
|
9537
9649
|
export interface SecretsAddFilterValuesResult {
|
|
9538
9650
|
/**
|
|
9539
9651
|
* Whether the values were successfully registered
|
|
@@ -9655,6 +9767,7 @@ export interface ServerInstructionSourceList {
|
|
|
9655
9767
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9656
9768
|
* via the `definition` "ServerSkill".
|
|
9657
9769
|
*/
|
|
9770
|
+
/** @experimental */
|
|
9658
9771
|
export interface ServerSkill {
|
|
9659
9772
|
/**
|
|
9660
9773
|
* Unique identifier for the skill
|
|
@@ -9692,6 +9805,7 @@ export interface ServerSkill {
|
|
|
9692
9805
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
9693
9806
|
* via the `definition` "ServerSkillList".
|
|
9694
9807
|
*/
|
|
9808
|
+
/** @experimental */
|
|
9695
9809
|
export interface ServerSkillList {
|
|
9696
9810
|
/**
|
|
9697
9811
|
* All discovered skills across all sources
|
|
@@ -10026,6 +10140,7 @@ export interface SessionFsRmRequest {
|
|
|
10026
10140
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10027
10141
|
* via the `definition` "SessionFsSetProviderCapabilities".
|
|
10028
10142
|
*/
|
|
10143
|
+
/** @experimental */
|
|
10029
10144
|
export interface SessionFsSetProviderCapabilities {
|
|
10030
10145
|
/**
|
|
10031
10146
|
* Whether the provider supports SQLite query/exists operations
|
|
@@ -10038,6 +10153,7 @@ export interface SessionFsSetProviderCapabilities {
|
|
|
10038
10153
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10039
10154
|
* via the `definition` "SessionFsSetProviderRequest".
|
|
10040
10155
|
*/
|
|
10156
|
+
/** @experimental */
|
|
10041
10157
|
export interface SessionFsSetProviderRequest {
|
|
10042
10158
|
/**
|
|
10043
10159
|
* Initial working directory for sessions
|
|
@@ -10056,6 +10172,7 @@ export interface SessionFsSetProviderRequest {
|
|
|
10056
10172
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10057
10173
|
* via the `definition` "SessionFsSetProviderResult".
|
|
10058
10174
|
*/
|
|
10175
|
+
/** @experimental */
|
|
10059
10176
|
export interface SessionFsSetProviderResult {
|
|
10060
10177
|
/**
|
|
10061
10178
|
* Whether the provider was set successfully
|
|
@@ -10388,6 +10505,10 @@ export interface SessionMetadataSnapshot {
|
|
|
10388
10505
|
* Currently selected model identifier, if any
|
|
10389
10506
|
*/
|
|
10390
10507
|
selectedModel?: string;
|
|
10508
|
+
/**
|
|
10509
|
+
* Current response limits for the session, or null when no limits are active
|
|
10510
|
+
*/
|
|
10511
|
+
responseLimits: ResponseLimitsConfig | null;
|
|
10391
10512
|
/**
|
|
10392
10513
|
* Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags).
|
|
10393
10514
|
*/
|
|
@@ -10600,7 +10721,7 @@ export interface SessionOpenOptions {
|
|
|
10600
10721
|
*/
|
|
10601
10722
|
maxInlineBinaryBytes?: number;
|
|
10602
10723
|
modelCapabilitiesOverrides?: ModelCapabilitiesOverride;
|
|
10603
|
-
|
|
10724
|
+
responseLimits?: ResponseLimitsConfig;
|
|
10604
10725
|
/**
|
|
10605
10726
|
* Runtime context discriminator for agent filtering.
|
|
10606
10727
|
*/
|
|
@@ -11598,9 +11719,9 @@ export interface SessionUpdateOptionsParams {
|
|
|
11598
11719
|
enableSkills?: boolean;
|
|
11599
11720
|
contextTier?: OptionsUpdateContextTier;
|
|
11600
11721
|
/**
|
|
11601
|
-
* Optional response
|
|
11722
|
+
* Optional response limits. Pass null to clear the response limits.
|
|
11602
11723
|
*/
|
|
11603
|
-
|
|
11724
|
+
responseLimits?: ResponseLimitsConfig | null;
|
|
11604
11725
|
}
|
|
11605
11726
|
/**
|
|
11606
11727
|
* Indicates whether the session options patch was applied successfully.
|
|
@@ -11812,6 +11933,7 @@ export interface SkillList {
|
|
|
11812
11933
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11813
11934
|
* via the `definition` "SkillsConfigSetDisabledSkillsRequest".
|
|
11814
11935
|
*/
|
|
11936
|
+
/** @experimental */
|
|
11815
11937
|
export interface SkillsConfigSetDisabledSkillsRequest {
|
|
11816
11938
|
/**
|
|
11817
11939
|
* List of skill names to disable
|
|
@@ -11837,6 +11959,7 @@ export interface SkillsDisableRequest {
|
|
|
11837
11959
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11838
11960
|
* via the `definition` "SkillsDiscoverRequest".
|
|
11839
11961
|
*/
|
|
11962
|
+
/** @experimental */
|
|
11840
11963
|
export interface SkillsDiscoverRequest {
|
|
11841
11964
|
/**
|
|
11842
11965
|
* Optional list of project directory paths to scan for project-scoped skills
|
|
@@ -12526,6 +12649,7 @@ export interface TelemetrySetFeatureOverridesRequest {
|
|
|
12526
12649
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12527
12650
|
* via the `definition` "Tool".
|
|
12528
12651
|
*/
|
|
12652
|
+
/** @experimental */
|
|
12529
12653
|
export interface Tool {
|
|
12530
12654
|
/**
|
|
12531
12655
|
* Tool identifier (e.g., "bash", "grep", "str_replace_editor")
|
|
@@ -12556,6 +12680,7 @@ export interface Tool {
|
|
|
12556
12680
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12557
12681
|
* via the `definition` "ToolList".
|
|
12558
12682
|
*/
|
|
12683
|
+
/** @experimental */
|
|
12559
12684
|
export interface ToolList {
|
|
12560
12685
|
/**
|
|
12561
12686
|
* List of available built-in tools with metadata
|
|
@@ -12590,6 +12715,7 @@ export interface ToolsInitializeAndValidateResult {
|
|
|
12590
12715
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
12591
12716
|
* via the `definition` "ToolsListRequest".
|
|
12592
12717
|
*/
|
|
12718
|
+
/** @experimental */
|
|
12593
12719
|
export interface ToolsListRequest {
|
|
12594
12720
|
/**
|
|
12595
12721
|
* Optional model ID — when provided, the returned tool list reflects model-specific overrides
|
|
@@ -13370,6 +13496,120 @@ export interface UserRequestedShellCommandResult {
|
|
|
13370
13496
|
*/
|
|
13371
13497
|
error?: string;
|
|
13372
13498
|
}
|
|
13499
|
+
/**
|
|
13500
|
+
* A single user setting's effective value alongside its default, so consumers can render settings left at their default.
|
|
13501
|
+
*
|
|
13502
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13503
|
+
* via the `definition` "UserSettingMetadata".
|
|
13504
|
+
*/
|
|
13505
|
+
/** @experimental */
|
|
13506
|
+
export interface UserSettingMetadata {
|
|
13507
|
+
/**
|
|
13508
|
+
* The effective value: the user's value if set, otherwise the default.
|
|
13509
|
+
*/
|
|
13510
|
+
value: {
|
|
13511
|
+
[k: string]: unknown | undefined;
|
|
13512
|
+
};
|
|
13513
|
+
/**
|
|
13514
|
+
* The centrally-known default for this setting (null when no default is registered).
|
|
13515
|
+
*/
|
|
13516
|
+
default: {
|
|
13517
|
+
[k: string]: unknown | undefined;
|
|
13518
|
+
};
|
|
13519
|
+
/**
|
|
13520
|
+
* True when the user has not set an explicit value for this setting (i.e. it is left at its default). Reflects whether the user has overridden the key, not whether the effective value happens to equal the default — a key explicitly set to a value identical to the default still reports false.
|
|
13521
|
+
*/
|
|
13522
|
+
isDefault: boolean;
|
|
13523
|
+
}
|
|
13524
|
+
/**
|
|
13525
|
+
* Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides.
|
|
13526
|
+
*
|
|
13527
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13528
|
+
* via the `definition` "UserSettingsGetResult".
|
|
13529
|
+
*/
|
|
13530
|
+
/** @experimental */
|
|
13531
|
+
export interface UserSettingsGetResult {
|
|
13532
|
+
/**
|
|
13533
|
+
* Every known user setting keyed by setting name, each with its effective value, default, and whether it is at the default.
|
|
13534
|
+
*/
|
|
13535
|
+
settings: {
|
|
13536
|
+
[k: string]: UserSettingMetadata;
|
|
13537
|
+
};
|
|
13538
|
+
}
|
|
13539
|
+
/**
|
|
13540
|
+
* Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed.
|
|
13541
|
+
*
|
|
13542
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13543
|
+
* via the `definition` "UserSettingsSetRequest".
|
|
13544
|
+
*/
|
|
13545
|
+
/** @experimental */
|
|
13546
|
+
export interface UserSettingsSetRequest {
|
|
13547
|
+
/**
|
|
13548
|
+
* Partial user settings to write, as a free-form object keyed by setting name
|
|
13549
|
+
*/
|
|
13550
|
+
settings: {
|
|
13551
|
+
[k: string]: unknown | undefined;
|
|
13552
|
+
};
|
|
13553
|
+
}
|
|
13554
|
+
/**
|
|
13555
|
+
* Outcome of writing user settings.
|
|
13556
|
+
*
|
|
13557
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13558
|
+
* via the `definition` "UserSettingsSetResult".
|
|
13559
|
+
*/
|
|
13560
|
+
/** @experimental */
|
|
13561
|
+
export interface UserSettingsSetResult {
|
|
13562
|
+
/**
|
|
13563
|
+
* Top-level keys whose write landed in settings.json but is shadowed by a value still present in the legacy config.json (config.json wins on read). The write does not take effect until the legacy value is removed.
|
|
13564
|
+
*/
|
|
13565
|
+
shadowedKeys: string[];
|
|
13566
|
+
}
|
|
13567
|
+
/**
|
|
13568
|
+
* Current sharing status and shareable GitHub URL for a session.
|
|
13569
|
+
*
|
|
13570
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13571
|
+
* via the `definition` "VisibilityGetResult".
|
|
13572
|
+
*/
|
|
13573
|
+
/** @experimental */
|
|
13574
|
+
export interface VisibilityGetResult {
|
|
13575
|
+
/**
|
|
13576
|
+
* Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the session cannot be shared and `status`/`shareUrl` are absent.
|
|
13577
|
+
*/
|
|
13578
|
+
synced: boolean;
|
|
13579
|
+
status?: SessionVisibilityStatus;
|
|
13580
|
+
/**
|
|
13581
|
+
* Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved.
|
|
13582
|
+
*/
|
|
13583
|
+
shareUrl?: string;
|
|
13584
|
+
}
|
|
13585
|
+
/**
|
|
13586
|
+
* Desired sharing status for the session.
|
|
13587
|
+
*
|
|
13588
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13589
|
+
* via the `definition` "VisibilitySetRequest".
|
|
13590
|
+
*/
|
|
13591
|
+
/** @experimental */
|
|
13592
|
+
export interface VisibilitySetRequest {
|
|
13593
|
+
status: SessionVisibilityStatus;
|
|
13594
|
+
}
|
|
13595
|
+
/**
|
|
13596
|
+
* Effective sharing status and shareable GitHub URL after updating session visibility.
|
|
13597
|
+
*
|
|
13598
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
13599
|
+
* via the `definition` "VisibilitySetResult".
|
|
13600
|
+
*/
|
|
13601
|
+
/** @experimental */
|
|
13602
|
+
export interface VisibilitySetResult {
|
|
13603
|
+
/**
|
|
13604
|
+
* Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the visibility change could not be applied and `status`/`shareUrl` are absent.
|
|
13605
|
+
*/
|
|
13606
|
+
synced: boolean;
|
|
13607
|
+
status?: SessionVisibilityStatus;
|
|
13608
|
+
/**
|
|
13609
|
+
* Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved.
|
|
13610
|
+
*/
|
|
13611
|
+
shareUrl?: string;
|
|
13612
|
+
}
|
|
13373
13613
|
/**
|
|
13374
13614
|
* A single changed file and its unified diff.
|
|
13375
13615
|
*
|
|
@@ -13654,8 +13894,11 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
13654
13894
|
* @param params Optional message to echo back to the caller.
|
|
13655
13895
|
*
|
|
13656
13896
|
* @returns Server liveness response, including the echoed message, current server timestamp, and protocol version.
|
|
13897
|
+
*
|
|
13898
|
+
* @experimental
|
|
13657
13899
|
*/
|
|
13658
13900
|
ping: (params: PingRequest) => Promise<PingResult>;
|
|
13901
|
+
/** @experimental */
|
|
13659
13902
|
models: {
|
|
13660
13903
|
/**
|
|
13661
13904
|
* Lists Copilot models available to the authenticated user.
|
|
@@ -13666,6 +13909,7 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
13666
13909
|
*/
|
|
13667
13910
|
list: (params: ModelsListRequest) => Promise<ModelList>;
|
|
13668
13911
|
};
|
|
13912
|
+
/** @experimental */
|
|
13669
13913
|
tools: {
|
|
13670
13914
|
/**
|
|
13671
13915
|
* Lists built-in tools available for a model.
|
|
@@ -13676,6 +13920,7 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
13676
13920
|
*/
|
|
13677
13921
|
list: (params: ToolsListRequest) => Promise<ToolList>;
|
|
13678
13922
|
};
|
|
13923
|
+
/** @experimental */
|
|
13679
13924
|
account: {
|
|
13680
13925
|
/**
|
|
13681
13926
|
* Gets Copilot quota usage for the authenticated user or supplied GitHub token.
|
|
@@ -13714,6 +13959,7 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
13714
13959
|
*/
|
|
13715
13960
|
logout: (params: AccountLogoutRequest) => Promise<AccountLogoutResult>;
|
|
13716
13961
|
};
|
|
13962
|
+
/** @experimental */
|
|
13717
13963
|
secrets: {
|
|
13718
13964
|
/**
|
|
13719
13965
|
* Registers secret values for redaction in session logs and exports. The SDK calls this to inject dynamically generated secret values (e.g., OIDC tokens).
|
|
@@ -13724,7 +13970,9 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
13724
13970
|
*/
|
|
13725
13971
|
addFilterValues: (params: SecretsAddFilterValuesRequest) => Promise<SecretsAddFilterValuesResult>;
|
|
13726
13972
|
};
|
|
13973
|
+
/** @experimental */
|
|
13727
13974
|
mcp: {
|
|
13975
|
+
/** @experimental */
|
|
13728
13976
|
config: {
|
|
13729
13977
|
/**
|
|
13730
13978
|
* Lists MCP servers from user configuration.
|
|
@@ -13866,7 +14114,9 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
13866
14114
|
refresh: (params: PluginsMarketplacesRefreshRequest) => Promise<MarketplaceRefreshResult>;
|
|
13867
14115
|
};
|
|
13868
14116
|
};
|
|
14117
|
+
/** @experimental */
|
|
13869
14118
|
skills: {
|
|
14119
|
+
/** @experimental */
|
|
13870
14120
|
config: {
|
|
13871
14121
|
/**
|
|
13872
14122
|
* Replaces the global list of disabled skills.
|
|
@@ -13889,8 +14139,6 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
13889
14139
|
* @param params Optional project paths to enumerate.
|
|
13890
14140
|
*
|
|
13891
14141
|
* @returns Canonical locations where skills can be created so the runtime will recognize them.
|
|
13892
|
-
*
|
|
13893
|
-
* @experimental
|
|
13894
14142
|
*/
|
|
13895
14143
|
getDiscoveryPaths: (params: SkillsGetDiscoveryPathsRequest) => Promise<SkillDiscoveryPathList>;
|
|
13896
14144
|
};
|
|
@@ -13932,20 +14180,38 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
13932
14180
|
*/
|
|
13933
14181
|
getDiscoveryPaths: (params: InstructionsGetDiscoveryPathsRequest) => Promise<InstructionDiscoveryPathList>;
|
|
13934
14182
|
};
|
|
14183
|
+
/** @experimental */
|
|
13935
14184
|
user: {
|
|
14185
|
+
/** @experimental */
|
|
13936
14186
|
settings: {
|
|
13937
14187
|
/**
|
|
13938
14188
|
* Drops this runtime process's in-memory user settings cache so the next settings read observes disk.
|
|
13939
14189
|
*/
|
|
13940
14190
|
reload: () => Promise<void>;
|
|
14191
|
+
/**
|
|
14192
|
+
* Lists every known user setting (settings.json overlaid with the legacy config.json, config.json wins), each with its effective value, its default, and whether it is at the default — so settings the user has never set still appear with their default value. Does not include repository- or enterprise-managed overrides that the runtime layers on top at session time.
|
|
14193
|
+
*
|
|
14194
|
+
* @returns Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default. Excludes repository- and enterprise-managed overrides.
|
|
14195
|
+
*/
|
|
14196
|
+
get: () => Promise<UserSettingsGetResult>;
|
|
14197
|
+
/**
|
|
14198
|
+
* Writes one or more user settings to settings.json, replacing each provided top-level key. A key whose value is null is removed. Returns the keys whose new value is shadowed by a legacy config.json entry (config.json wins on read), which the runtime leaves in place — such writes do not take effect until the legacy value is removed.
|
|
14199
|
+
*
|
|
14200
|
+
* @param params Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed.
|
|
14201
|
+
*
|
|
14202
|
+
* @returns Outcome of writing user settings.
|
|
14203
|
+
*/
|
|
14204
|
+
set: (params: UserSettingsSetRequest) => Promise<UserSettingsSetResult>;
|
|
13941
14205
|
};
|
|
13942
14206
|
};
|
|
14207
|
+
/** @experimental */
|
|
13943
14208
|
runtime: {
|
|
13944
14209
|
/**
|
|
13945
14210
|
* Gracefully shuts down an SDK-owned runtime. The response is sent only after cleanup completes; callers may then terminate the owned runtime process.
|
|
13946
14211
|
*/
|
|
13947
14212
|
shutdown: () => Promise<void>;
|
|
13948
14213
|
};
|
|
14214
|
+
/** @experimental */
|
|
13949
14215
|
sessionFs: {
|
|
13950
14216
|
/**
|
|
13951
14217
|
* Registers an SDK client as the session filesystem provider.
|
|
@@ -15405,6 +15671,23 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
15405
15671
|
notifySteerableChanged: (params: RemoteNotifySteerableChangedRequest) => Promise<RemoteNotifySteerableChangedResult>;
|
|
15406
15672
|
};
|
|
15407
15673
|
/** @experimental */
|
|
15674
|
+
visibility: {
|
|
15675
|
+
/**
|
|
15676
|
+
* Returns the session's current Mission Control sharing status and shareable GitHub URL. Reflects whether the synced session is visible to repository readers ("repo") or restricted to its creator and collaborators ("unshared").
|
|
15677
|
+
*
|
|
15678
|
+
* @returns Current sharing status and shareable GitHub URL for a session.
|
|
15679
|
+
*/
|
|
15680
|
+
get: () => Promise<VisibilityGetResult>;
|
|
15681
|
+
/**
|
|
15682
|
+
* Sets the session's Mission Control sharing status, controlling whether the synced session is visible to repository readers. Returns the effective status and shareable GitHub URL after the change.
|
|
15683
|
+
*
|
|
15684
|
+
* @param params Desired sharing status for the session.
|
|
15685
|
+
*
|
|
15686
|
+
* @returns Effective sharing status and shareable GitHub URL after updating session visibility.
|
|
15687
|
+
*/
|
|
15688
|
+
set: (params: VisibilitySetRequest) => Promise<VisibilitySetResult>;
|
|
15689
|
+
};
|
|
15690
|
+
/** @experimental */
|
|
15408
15691
|
schedule: {
|
|
15409
15692
|
/**
|
|
15410
15693
|
* Lists the session's currently active scheduled prompts.
|