@github/copilot-sdk-win32-x64 1.0.15-preview.0 → 1.0.15-preview.2
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/copilot-sdk/cliVersion.d.ts +1 -1
- package/copilot-sdk/client.d.ts +2 -0
- package/copilot-sdk/docs/extensions.md +1 -0
- package/copilot-sdk/docs/workflows.md +257 -0
- package/copilot-sdk/extension.d.ts +22 -8
- package/copilot-sdk/extension.js +1845 -230
- package/copilot-sdk/generated/rpc.d.ts +3141 -302
- package/copilot-sdk/generated/session-events.d.ts +762 -31
- package/copilot-sdk/index.d.ts +3 -1
- package/copilot-sdk/index.js +1839 -228
- package/copilot-sdk/schema.d.ts +4 -0
- package/copilot-sdk/session.d.ts +26 -3
- package/copilot-sdk/types.d.ts +37 -5
- package/copilot-sdk/workflow.d.ts +364 -0
- package/package.json +1 -1
- package/plugins/computer-use/CopilotComputerUse.exe +0 -0
- package/plugins/computer-use/computer-use-mcp.exe +0 -0
- package/plugins/computer-use/{.mcp.json → mcp.json} +2 -1
- package/plugins/computer-use/plugin.json +6 -0
- package/prebuilds/win32-x64/OneAuthInterop.dll +0 -0
- package/prebuilds/win32-x64/copilot-runtime.exe +0 -0
- package/prebuilds/win32-x64/msal-node-runtime.node +0 -0
- package/prebuilds/win32-x64/msalruntime.dll +0 -0
- package/prebuilds/win32-x64/runtime.node +2 -2
- package/preloads/extension_bootstrap.mjs +3 -4
- package/ripgrep/bin/win32-x64/rg.exe +0 -0
- package/schemas/api.schema.json +1117 -55
- package/schemas/session-events.schema.json +130 -1
- package/tgrep/bin/win32-x64/tgrep.exe +0 -0
- package/plugins/computer-use/.plugin/plugin.json +0 -6
- package/sdk/index.js +0 -1465
|
@@ -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, AgentModelPolicy, Attachment, AutoTier, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpOauthHttpResponse, McpOauthWWWAuthenticateParams, McpServerMetadata, McpServerSource, McpServerStatus, ModelChangeSource, PermissionDecisionSource, PermissionMode, PermissionPromptRequest, PermissionRule, ReasoningSummary, RemediationAction, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, TaskCompleteData, TaskCompletionOutcome, UserToolSessionApproval, Verbosity } from "./session-events.js";
|
|
6
|
+
import type { AbortReason, AgentModelPolicy, Attachment, AutoTier, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, IndexedSearchState, ManagedSettingsResolvedData, McpOauthHttpResponse, McpOauthWWWAuthenticateParams, McpServerMetadata, McpServerSource, McpServerStatus, ModelChangeSource, PermissionDecisionSource, PermissionMode, PermissionPromptRequest, PermissionRule, ReasoningSummary, RemediationAction, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, TaskCompleteData, TaskCompletionOutcome, UserToolSessionApproval, Verbosity } from "./session-events.js";
|
|
7
7
|
/** A value that can be represented losslessly on the SDK JSON wire. */
|
|
8
8
|
export type JsonValue = null | boolean | number | string | JsonValue[] | {
|
|
9
9
|
[key: string]: JsonValue;
|
|
@@ -38,8 +38,10 @@ export type AdaptiveThinkingSupport =
|
|
|
38
38
|
"unsupported"
|
|
39
39
|
/** The model accepts adaptive thinking but also accepts thinking.type='enabled' */
|
|
40
40
|
| "optional"
|
|
41
|
-
/** The model
|
|
42
|
-
| "required"
|
|
41
|
+
/** The model defaults to adaptive thinking and rejects thinking.type='enabled' with HTTP 400, but still accepts thinking.type='disabled' (e.g. opus-4.7/4.8/5, sonnet-5) */
|
|
42
|
+
| "required"
|
|
43
|
+
/** The model accepts only thinking.type='adaptive'; 'enabled', 'disabled', and an omitted thinking block all fail with HTTP 400 (e.g. fable, mythos) */
|
|
44
|
+
| "adaptive_only";
|
|
43
45
|
/**
|
|
44
46
|
* Which tier this directory belongs to
|
|
45
47
|
*
|
|
@@ -150,7 +152,7 @@ export type AgentRegistryLiveTargetEntryLastTerminalEvent =
|
|
|
150
152
|
/** Last turn was aborted (e.g. user interrupted) */
|
|
151
153
|
| "abort";
|
|
152
154
|
/**
|
|
153
|
-
* Categorized reason
|
|
155
|
+
* Categorized reason no canonical process log could be opened
|
|
154
156
|
*
|
|
155
157
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
156
158
|
* via the `definition` "AgentRegistryLogCaptureOpenErrorReason".
|
|
@@ -324,13 +326,53 @@ export type CardDigestAlgorithm = "sha256-rfc8785";
|
|
|
324
326
|
/** @experimental */
|
|
325
327
|
export type CardDigestValue = string;
|
|
326
328
|
/**
|
|
327
|
-
*
|
|
329
|
+
* Discriminator for an Agent Plugin candidate
|
|
328
330
|
*
|
|
329
331
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
330
|
-
* via the `definition` "
|
|
332
|
+
* via the `definition` "CatalogAgentPluginCandidateKind".
|
|
331
333
|
*/
|
|
332
334
|
/** @experimental */
|
|
333
|
-
export type
|
|
335
|
+
export type CatalogAgentPluginCandidateKind = "plugin";
|
|
336
|
+
/**
|
|
337
|
+
* Canonical Agent Plugin media type
|
|
338
|
+
*
|
|
339
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
340
|
+
* via the `definition` "CatalogAgentPluginMediaType".
|
|
341
|
+
*/
|
|
342
|
+
/** @experimental */
|
|
343
|
+
export type CatalogAgentPluginMediaType =
|
|
344
|
+
/** A GitHub Copilot Agent Plugin descriptor. */
|
|
345
|
+
"application/vnd.github.copilot-plugin";
|
|
346
|
+
/**
|
|
347
|
+
* Canonical catalogue resource identity. The runtime rewrites accepted urn:ai and urn:air identifiers to urn:air, lowercases the authority, and preserves the remaining resource components.
|
|
348
|
+
*
|
|
349
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
350
|
+
* via the `definition` "CatalogResourceIdentity".
|
|
351
|
+
*/
|
|
352
|
+
/** @experimental */
|
|
353
|
+
export type CatalogResourceIdentity = string;
|
|
354
|
+
/**
|
|
355
|
+
* Bounded source-declared resource version, preserved exactly after validation and never inferred.
|
|
356
|
+
*
|
|
357
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
358
|
+
* via the `definition` "CatalogResourceVersion".
|
|
359
|
+
*/
|
|
360
|
+
/** @experimental */
|
|
361
|
+
export type CatalogResourceVersion = string;
|
|
362
|
+
/**
|
|
363
|
+
* Explicit Agent Plugin compatibility declared by exact catalog tags. Clients must not infer these values from display text or other metadata.
|
|
364
|
+
*
|
|
365
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
366
|
+
* via the `definition` "CatalogAgentPluginCompatibilityTag".
|
|
367
|
+
*/
|
|
368
|
+
/** @experimental */
|
|
369
|
+
export type CatalogAgentPluginCompatibilityTag =
|
|
370
|
+
/** The plugin contributes at least one GitHub Copilot Canvas. */
|
|
371
|
+
"canvas"
|
|
372
|
+
/** The plugin depends on Canvas for its intended functionality. */
|
|
373
|
+
| "canvas-only"
|
|
374
|
+
/** The plugin targets GitHub Copilot. */
|
|
375
|
+
| "github-copilot";
|
|
334
376
|
/**
|
|
335
377
|
* A versioned, bounded trust observation carried unchanged with a catalog candidate and its private handle context. Current observations require a recognised T1/T2 tier; every non-current state structurally forbids a tier. Eligibility remains `unknown` while Agent Finder supplies no exposure decision, and states absent from its current wire are never inferred from age, relevance, popularity, or a tier transition.
|
|
336
378
|
*
|
|
@@ -449,6 +491,38 @@ export type CatalogTrustSnapshotUnsupportedStatus =
|
|
|
449
491
|
export type CatalogTrustSnapshotMalformedStatus =
|
|
450
492
|
/** The trust field was empty, unbounded, or had the wrong JSON type. */
|
|
451
493
|
"malformed";
|
|
494
|
+
/**
|
|
495
|
+
* Discriminator for an AI skill candidate
|
|
496
|
+
*
|
|
497
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
498
|
+
* via the `definition` "CatalogAiSkillCandidateKind".
|
|
499
|
+
*/
|
|
500
|
+
/** @experimental */
|
|
501
|
+
export type CatalogAiSkillCandidateKind = "ai-skill";
|
|
502
|
+
/**
|
|
503
|
+
* Canonical AI skill media type
|
|
504
|
+
*
|
|
505
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
506
|
+
* via the `definition` "CatalogAiSkillMediaType".
|
|
507
|
+
*/
|
|
508
|
+
/** @experimental */
|
|
509
|
+
export type CatalogAiSkillMediaType = "application/ai-skill";
|
|
510
|
+
/**
|
|
511
|
+
* Typed non-installable state for an AI skill candidate
|
|
512
|
+
*
|
|
513
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
514
|
+
* via the `definition` "CatalogAiSkillInstallability".
|
|
515
|
+
*/
|
|
516
|
+
/** @experimental */
|
|
517
|
+
export type CatalogAiSkillInstallability = "not-installable-kind";
|
|
518
|
+
/**
|
|
519
|
+
* Where a candidate's card came from. Exactly one of a URL or embedded data: the union has no variant carrying both, and no variant carrying neither, so the rule holds structurally rather than by validation.
|
|
520
|
+
*
|
|
521
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
522
|
+
* via the `definition` "CatalogCandidateSource".
|
|
523
|
+
*/
|
|
524
|
+
/** @experimental */
|
|
525
|
+
export type CatalogCandidateSource = CatalogCandidateSourceUrl | CatalogCandidateSourceEmbedded;
|
|
452
526
|
/**
|
|
453
527
|
* Why the catalog authority did not accept the caller's identity
|
|
454
528
|
*
|
|
@@ -464,13 +538,21 @@ export type CatalogAuthenticationRequiredReason =
|
|
|
464
538
|
/** A credential was presented and the authority refused it, for example because it was revoked, malformed, or issued for another audience. Refreshing the same rejected credential is not useful; the caller must sign in again. */
|
|
465
539
|
| "credential-rejected";
|
|
466
540
|
/**
|
|
467
|
-
* One inert catalog result, represented as an MCP server
|
|
541
|
+
* One inert catalog result, represented as an MCP server, discovery-only AI skill, or opt-in Agent Plugin variant so kind, media type, provenance, and available operations cannot contradict each other.
|
|
468
542
|
*
|
|
469
543
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
470
544
|
* via the `definition` "CatalogCandidate".
|
|
471
545
|
*/
|
|
472
546
|
/** @experimental */
|
|
473
|
-
export type CatalogCandidate = CatalogMcpServerCandidate | CatalogAiSkillCandidate;
|
|
547
|
+
export type CatalogCandidate = CatalogMcpServerCandidate | CatalogAiSkillCandidate | CatalogAgentPluginCandidate;
|
|
548
|
+
/**
|
|
549
|
+
* Discriminator for an MCP server candidate
|
|
550
|
+
*
|
|
551
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
552
|
+
* via the `definition` "CatalogMcpServerCandidateKind".
|
|
553
|
+
*/
|
|
554
|
+
/** @experimental */
|
|
555
|
+
export type CatalogMcpServerCandidateKind = "mcp-server";
|
|
474
556
|
/**
|
|
475
557
|
* JSON MCP card media type accepted for install planning
|
|
476
558
|
*
|
|
@@ -506,7 +588,9 @@ export type CatalogCandidateKind =
|
|
|
506
588
|
/** An MCP server, which can be planned for installation. */
|
|
507
589
|
"mcp-server"
|
|
508
590
|
/** An AI skill, which is discoverable but not installable through this surface. */
|
|
509
|
-
| "ai-skill"
|
|
591
|
+
| "ai-skill"
|
|
592
|
+
/** An inert Agent Plugin candidate, available only when explicitly requested. */
|
|
593
|
+
| "plugin";
|
|
510
594
|
/**
|
|
511
595
|
* A wire feature a caller can require of the catalog surface, negotiated per request. A grant means the runtime understands the feature's contract, not that the deployment has enabled the operation; typed unavailable results report availability separately.
|
|
512
596
|
*
|
|
@@ -521,12 +605,20 @@ export type CatalogCapability =
|
|
|
521
605
|
| "legacy-mcp-server-card"
|
|
522
606
|
/** Understands `application/ai-skill` candidates as discovery-only and typed non-installable. */
|
|
523
607
|
| "ai-skill-discovery"
|
|
608
|
+
/** Understands opt-in `application/vnd.github.copilot-plugin` candidates and their typed identity, version, source, and compatibility fields. */
|
|
609
|
+
| "agent-plugin-discovery"
|
|
524
610
|
/** Understands side-effect-free MCP install-plan requests, results, and plan handles; `planning-unavailable` separately reports that planning is not enabled. */
|
|
525
611
|
| "mcp-install-planning"
|
|
526
612
|
/** Understands plans that enumerate every eligible transport rather than a single preferred one. */
|
|
527
613
|
| "multiple-transport-choice"
|
|
614
|
+
/** Understands explicit numbered navigation and authority-reported pagination metadata with opaque tokens. Advertised and granted only when requested. */
|
|
615
|
+
| "catalog-search-pagination"
|
|
528
616
|
/** Understands versioned candidate trust snapshots. Protocol-3 callers must require this capability before the runtime adds the optional snapshot field. */
|
|
529
|
-
| "trust-snapshot"
|
|
617
|
+
| "trust-snapshot"
|
|
618
|
+
/** Understands exact candidate selection through model-safe opaque references and host-only candidate-handle hand-off. */
|
|
619
|
+
| "catalog-selection"
|
|
620
|
+
/** Requires an eligible credential for the selected GitHub.com account before search egress and prohibits client-side anonymous retry, including after HTTP 401 or 403. The credential is scoped to the fixed catalog authority without redirect forwarding. Neither a grant nor successful response proves that the authority accepted the identity or selected a particular backend. Preserve this requirement on every page and retry; callers omitting it retain optional authentication. */
|
|
621
|
+
| "catalog-search-credential-required";
|
|
530
622
|
/**
|
|
531
623
|
* Bounded extensible wire-feature identifier. Known values are described by `CatalogCapability`; newer callers may send future identifiers so an older runtime can return a typed negotiation refusal instead of failing schema validation. Capability negotiation establishes contract understanding, while each operation's result separately reports runtime availability.
|
|
532
624
|
*
|
|
@@ -547,7 +639,7 @@ export type CatalogContractViolationReason =
|
|
|
547
639
|
"both-url-and-data"
|
|
548
640
|
/** A result carried neither a URL nor embedded data, when exactly one is required. */
|
|
549
641
|
| "neither-url-nor-data"
|
|
550
|
-
/** Two results claimed the same normalised identity. */
|
|
642
|
+
/** Two results claimed the same collision key: normalised identity for existing kinds, or normalised identity and declared version for Agent Plugins. */
|
|
551
643
|
| "duplicate-identity"
|
|
552
644
|
/** A result declared no media type, or one this contract does not model. */
|
|
553
645
|
| "unknown-media-type";
|
|
@@ -562,7 +654,9 @@ export type CatalogHandleType =
|
|
|
562
654
|
/** A search candidate handle. */
|
|
563
655
|
"candidate"
|
|
564
656
|
/** An install plan handle. */
|
|
565
|
-
| "plan"
|
|
657
|
+
| "plan"
|
|
658
|
+
/** A model-safe reference to one retained search candidate. */
|
|
659
|
+
| "selection";
|
|
566
660
|
/**
|
|
567
661
|
* Why a presented handle was rejected
|
|
568
662
|
*
|
|
@@ -571,16 +665,20 @@ export type CatalogHandleType =
|
|
|
571
665
|
*/
|
|
572
666
|
/** @experimental */
|
|
573
667
|
export type CatalogHandleRejectionReason =
|
|
574
|
-
/** The handle is unparseable
|
|
668
|
+
/** The handle is unparseable or unknown. */
|
|
575
669
|
"invalid"
|
|
576
670
|
/** The handle's time to live has elapsed. */
|
|
577
671
|
| "stale"
|
|
578
672
|
/** The handle has already been used, and handles are single-use. */
|
|
579
673
|
| "replayed"
|
|
580
|
-
/** The handle was issued by a different runtime instance. */
|
|
581
|
-
| "foreign"
|
|
674
|
+
/** The handle was issued by a different runtime instance or session. */
|
|
675
|
+
| "foreign"
|
|
676
|
+
/** The handle was issued for another catalog operation. */
|
|
677
|
+
| "wrong-kind"
|
|
678
|
+
/** The supplied search identifier does not match the retained candidate. */
|
|
679
|
+
| "search-mismatch";
|
|
582
680
|
/**
|
|
583
|
-
* Which request field was rejected
|
|
681
|
+
* Which request field was rejected locally or by the catalog authority
|
|
584
682
|
*
|
|
585
683
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
586
684
|
* via the `definition` "CatalogInvalidRequestField".
|
|
@@ -600,7 +698,15 @@ export type CatalogInvalidRequestField =
|
|
|
600
698
|
/** The supplied card was missing its media type, URL, or data. */
|
|
601
699
|
| "card"
|
|
602
700
|
/** The requested configuration scope is not one this runtime writes. */
|
|
603
|
-
| "scope"
|
|
701
|
+
| "scope"
|
|
702
|
+
/** The pagination token or target was invalid, or the authority rejected the continuation. Repeat the search without page. */
|
|
703
|
+
| "page"
|
|
704
|
+
/** The locally owned session identifier was missing or malformed. */
|
|
705
|
+
| "sessionId"
|
|
706
|
+
/** The opaque selection reference was missing or malformed. */
|
|
707
|
+
| "selectionRef"
|
|
708
|
+
/** The terminal selection outcome was missing or unsupported. */
|
|
709
|
+
| "outcome";
|
|
604
710
|
/**
|
|
605
711
|
* How a card failed validation
|
|
606
712
|
*
|
|
@@ -632,7 +738,9 @@ export type CatalogMediaType =
|
|
|
632
738
|
/** The legacy MCP server card media type, accepted for compatibility. */
|
|
633
739
|
| "application/mcp-server+json"
|
|
634
740
|
/** An AI skill card. Representable and searchable, but typed non-installable. */
|
|
635
|
-
| "application/ai-skill"
|
|
741
|
+
| "application/ai-skill"
|
|
742
|
+
/** An inert Agent Plugin descriptor. */
|
|
743
|
+
| "application/vnd.github.copilot-plugin";
|
|
636
744
|
/**
|
|
637
745
|
* Why capability and protocol-version negotiation refused a caller
|
|
638
746
|
*
|
|
@@ -705,6 +813,16 @@ export type McpPlanPolicySource =
|
|
|
705
813
|
| "registry-policy"
|
|
706
814
|
/** Local trust settings evaluated the server. */
|
|
707
815
|
| "local-trust";
|
|
816
|
+
/**
|
|
817
|
+
* Relationship of the backend-reported count to the complete query result set.
|
|
818
|
+
*
|
|
819
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
820
|
+
* via the `definition` "CatalogSearchTotalCountRelation".
|
|
821
|
+
*/
|
|
822
|
+
/** @experimental */
|
|
823
|
+
export type CatalogSearchTotalCountRelation =
|
|
824
|
+
/** No exact/full-query or lower-bound guarantee is available. */
|
|
825
|
+
"unknown";
|
|
708
826
|
/**
|
|
709
827
|
* Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success.
|
|
710
828
|
*
|
|
@@ -745,10 +863,36 @@ export type CatalogUnavailableReason =
|
|
|
745
863
|
"search-unavailable"
|
|
746
864
|
/** Install planning is not wired up on this runtime build. */
|
|
747
865
|
| "planning-unavailable"
|
|
866
|
+
/** Exact candidate selection is not available in this session or runtime. */
|
|
867
|
+
| "selection-unavailable"
|
|
748
868
|
/** No catalog authority is configured for this runtime. */
|
|
749
869
|
| "authority-not-configured"
|
|
750
870
|
/** The surface is disabled by policy on this runtime. */
|
|
751
871
|
| "disabled-by-policy";
|
|
872
|
+
/**
|
|
873
|
+
* Terminal outcome declared for a retained catalog selection group
|
|
874
|
+
*
|
|
875
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
876
|
+
* via the `definition` "CatalogSelectionDecision".
|
|
877
|
+
*/
|
|
878
|
+
/** @experimental */
|
|
879
|
+
export type CatalogSelectionDecision =
|
|
880
|
+
/** Choose the candidate named by selectionRef. */
|
|
881
|
+
"selected"
|
|
882
|
+
/** Explicitly decline every candidate in the search. */
|
|
883
|
+
| "declined"
|
|
884
|
+
/** Cancel the selection interaction without choosing a candidate. */
|
|
885
|
+
| "cancelled"
|
|
886
|
+
/** Declare that the host's live interaction deadline elapsed while the reference remained valid. */
|
|
887
|
+
| "timed-out";
|
|
888
|
+
/**
|
|
889
|
+
* Typed outcome of catalog.select. Only the selected host result carries a fresh candidate handle; the model-facing projection removes both that handle and searchId.
|
|
890
|
+
*
|
|
891
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
892
|
+
* via the `definition` "CatalogSelectionResult".
|
|
893
|
+
*/
|
|
894
|
+
/** @experimental */
|
|
895
|
+
export type CatalogSelectionResult = CatalogSelectionSelected | CatalogSelectionDeclined | CatalogSelectionCancelled | CatalogSelectionTimedOut | CatalogSelectionInvalid | CatalogSelectionStale | CatalogSelectionReplayed | CatalogSelectionForeign | CatalogSelectionWrongKind | CatalogNegotiationRefusedError | CatalogInvalidRequestError | CatalogUnavailableError;
|
|
752
896
|
/**
|
|
753
897
|
* Why no usable transport could be offered
|
|
754
898
|
*
|
|
@@ -854,6 +998,106 @@ export type ConnectedRemoteSessionMetadataKind =
|
|
|
854
998
|
"remote-session"
|
|
855
999
|
/** GitHub Copilot coding agent session. */
|
|
856
1000
|
| "coding-agent";
|
|
1001
|
+
/**
|
|
1002
|
+
* Stable OAuth scope whose absence prevents Connector management.
|
|
1003
|
+
*
|
|
1004
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1005
|
+
* via the `definition` "ConnectorAuthorizationScope".
|
|
1006
|
+
*/
|
|
1007
|
+
/** @experimental */
|
|
1008
|
+
export type ConnectorAuthorizationScope =
|
|
1009
|
+
/** Allows Copilot to manage Connector connections and use their tools. */
|
|
1010
|
+
"write_plugin_gateway_connections";
|
|
1011
|
+
/**
|
|
1012
|
+
* Availability of the EXPERIMENTAL session connector API.
|
|
1013
|
+
*
|
|
1014
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1015
|
+
* via the `definition` "ConnectorAvailability".
|
|
1016
|
+
*/
|
|
1017
|
+
/** @experimental */
|
|
1018
|
+
export type ConnectorAvailability =
|
|
1019
|
+
/** The resolved Connector feature is enabled and Connector requests are permitted. */
|
|
1020
|
+
"enabled"
|
|
1021
|
+
/** The resolved Connector feature is off. No Connector service request is made while disabled. */
|
|
1022
|
+
| "disabled"
|
|
1023
|
+
/** The session has no eligible host-owned GitHub account or does not support local Connector projection. */
|
|
1024
|
+
| "unavailable";
|
|
1025
|
+
/**
|
|
1026
|
+
* Authoritative service connection state for one Connector.
|
|
1027
|
+
*
|
|
1028
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1029
|
+
* via the `definition` "ConnectorCatalogStatus".
|
|
1030
|
+
*/
|
|
1031
|
+
/** @experimental */
|
|
1032
|
+
export type ConnectorCatalogStatus =
|
|
1033
|
+
/** The Connector is available but not connected. */
|
|
1034
|
+
"not_connected"
|
|
1035
|
+
/** The Connector service is still completing connection or consent. */
|
|
1036
|
+
| "pending"
|
|
1037
|
+
/** The Connector is connected and may contribute MCP servers. */
|
|
1038
|
+
| "connected"
|
|
1039
|
+
/** The Connector service reports an unusable connection. */
|
|
1040
|
+
| "error"
|
|
1041
|
+
/** The service returned a future or unrecognized state. */
|
|
1042
|
+
| "unknown";
|
|
1043
|
+
/**
|
|
1044
|
+
* Typed result of initiating or continuing a Connector connection.
|
|
1045
|
+
*
|
|
1046
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1047
|
+
* via the `definition` "ConnectorConnectResult".
|
|
1048
|
+
*/
|
|
1049
|
+
/** @experimental */
|
|
1050
|
+
export type ConnectorConnectResult = {
|
|
1051
|
+
/**
|
|
1052
|
+
* The service is connected and the session MCP graph was reconciled.
|
|
1053
|
+
*/
|
|
1054
|
+
kind: "connected";
|
|
1055
|
+
status: ConnectorStatus;
|
|
1056
|
+
} | {
|
|
1057
|
+
/**
|
|
1058
|
+
* Host-owned consent is required before bounded continuation can complete.
|
|
1059
|
+
*/
|
|
1060
|
+
kind: "consent_required";
|
|
1061
|
+
/**
|
|
1062
|
+
* Validated HTTPS consent URL. The runtime does not open it.
|
|
1063
|
+
*/
|
|
1064
|
+
consentUrl: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* Opaque ID accepted by continueConnection.
|
|
1067
|
+
*/
|
|
1068
|
+
continuationId: string;
|
|
1069
|
+
} | {
|
|
1070
|
+
/**
|
|
1071
|
+
* The service is still completing the connection without a consent URL.
|
|
1072
|
+
*/
|
|
1073
|
+
kind: "pending";
|
|
1074
|
+
/**
|
|
1075
|
+
* Opaque ID accepted by continueConnection.
|
|
1076
|
+
*/
|
|
1077
|
+
continuationId: string;
|
|
1078
|
+
};
|
|
1079
|
+
/**
|
|
1080
|
+
* Live MCP status of one Connector-owned runtime server.
|
|
1081
|
+
*
|
|
1082
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1083
|
+
* via the `definition` "ConnectorMcpStatus".
|
|
1084
|
+
*/
|
|
1085
|
+
/** @experimental */
|
|
1086
|
+
export type ConnectorMcpStatus =
|
|
1087
|
+
/** The server is connected and its tools are available. */
|
|
1088
|
+
"connected"
|
|
1089
|
+
/** The server connection is still being established. */
|
|
1090
|
+
| "pending"
|
|
1091
|
+
/** The server requires refreshed GitHub authorization. */
|
|
1092
|
+
| "needs_auth"
|
|
1093
|
+
/** The server failed to connect or initialize. */
|
|
1094
|
+
| "failed"
|
|
1095
|
+
/** The server is intentionally stopped, including when managed policy blocks it. */
|
|
1096
|
+
| "stopped"
|
|
1097
|
+
/** The server is configured but explicitly disabled. */
|
|
1098
|
+
| "disabled"
|
|
1099
|
+
/** The Connector currently has no live server configuration. */
|
|
1100
|
+
| "not_configured";
|
|
857
1101
|
/**
|
|
858
1102
|
* Closed set of public task kinds a connection can negotiate.
|
|
859
1103
|
*
|
|
@@ -899,7 +1143,7 @@ export type DebugCollectLogsSource =
|
|
|
899
1143
|
/** Caller-provided diagnostic entry. */
|
|
900
1144
|
| "additional";
|
|
901
1145
|
/**
|
|
902
|
-
* Destination for the
|
|
1146
|
+
* Destination for the session debug bundle.
|
|
903
1147
|
*
|
|
904
1148
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
905
1149
|
* via the `definition` "DebugCollectLogsDestination".
|
|
@@ -920,7 +1164,7 @@ export type DebugCollectLogsDestination = {
|
|
|
920
1164
|
kind: "archive";
|
|
921
1165
|
} | {
|
|
922
1166
|
/**
|
|
923
|
-
* Directory where
|
|
1167
|
+
* Directory where files should be staged. The directory is created if needed.
|
|
924
1168
|
*/
|
|
925
1169
|
outputDirectory: string;
|
|
926
1170
|
/**
|
|
@@ -951,7 +1195,9 @@ export type DebugCollectLogsRedaction =
|
|
|
951
1195
|
/** Redact the file as plain UTF-8 log text. */
|
|
952
1196
|
"plain-text"
|
|
953
1197
|
/** Redact each non-empty line as a session event JSON object, falling back to plain-text redaction for malformed lines. */
|
|
954
|
-
| "events-jsonl"
|
|
1198
|
+
| "events-jsonl"
|
|
1199
|
+
/** No redaction is applied. The caller must ensure any necessary redaction is performed before this call. */
|
|
1200
|
+
| "none";
|
|
955
1201
|
/**
|
|
956
1202
|
* Destination kind that was written.
|
|
957
1203
|
*
|
|
@@ -962,7 +1208,7 @@ export type DebugCollectLogsRedaction =
|
|
|
962
1208
|
export type DebugCollectLogsResultKind =
|
|
963
1209
|
/** A .tgz archive was written. */
|
|
964
1210
|
"archive"
|
|
965
|
-
/** A directory containing
|
|
1211
|
+
/** A directory containing the collected files was written. */
|
|
966
1212
|
| "directory";
|
|
967
1213
|
/**
|
|
968
1214
|
* Persisted extension discovery source
|
|
@@ -1064,6 +1310,14 @@ export type DiscoveredMcpServerType =
|
|
|
1064
1310
|
| "sse"
|
|
1065
1311
|
/** Server is backed by an in-memory runtime implementation. */
|
|
1066
1312
|
| "memory";
|
|
1313
|
+
/**
|
|
1314
|
+
* Indicates whether the command was accepted into the local execution queue.
|
|
1315
|
+
*
|
|
1316
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
1317
|
+
* via the `definition` "EnqueueCommandResult".
|
|
1318
|
+
*/
|
|
1319
|
+
/** @experimental */
|
|
1320
|
+
export type EnqueueCommandResult = AcceptedEnqueueCommandResult | UnsupportedEnqueueCommandResult;
|
|
1067
1321
|
/**
|
|
1068
1322
|
* Either '*' to receive all event types, or a non-empty list of event types to receive
|
|
1069
1323
|
*
|
|
@@ -1860,6 +2114,10 @@ export type McpHeadersHandlePendingHeadersRefreshRequest = {
|
|
|
1860
2114
|
headers: {
|
|
1861
2115
|
[k: string]: string | undefined;
|
|
1862
2116
|
};
|
|
2117
|
+
/**
|
|
2118
|
+
* Optional lifetime in milliseconds for these returned headers. The runtime clamps its configured cache lifetime to this value.
|
|
2119
|
+
*/
|
|
2120
|
+
ttlMs?: number;
|
|
1863
2121
|
/**
|
|
1864
2122
|
* Headers-refresh response variant discriminator.
|
|
1865
2123
|
*/
|
|
@@ -1869,6 +2127,15 @@ export type McpHeadersHandlePendingHeadersRefreshRequest = {
|
|
|
1869
2127
|
* Headers-refresh response variant discriminator.
|
|
1870
2128
|
*/
|
|
1871
2129
|
kind: "none";
|
|
2130
|
+
} | {
|
|
2131
|
+
/**
|
|
2132
|
+
* Host credential broker failure, denial, or revocation reason.
|
|
2133
|
+
*/
|
|
2134
|
+
message: string;
|
|
2135
|
+
/**
|
|
2136
|
+
* Headers-refresh response variant discriminator.
|
|
2137
|
+
*/
|
|
2138
|
+
kind: "error";
|
|
1872
2139
|
};
|
|
1873
2140
|
/**
|
|
1874
2141
|
* One eligible way to run the server, represented as a tagged package or remote variant so package identity and endpoint states cannot contradict the install method.
|
|
@@ -2696,6 +2963,8 @@ export type PermissionModeSource =
|
|
|
2696
2963
|
| "autopilot_confirmation"
|
|
2697
2964
|
/** The mode was set at startup by the `defaultPermissionMode` user setting. */
|
|
2698
2965
|
| "user_setting"
|
|
2966
|
+
/** The mode was set at startup by authenticated organization targeting. */
|
|
2967
|
+
| "organization_targeting"
|
|
2699
2968
|
/** The mode was set through an RPC caller. */
|
|
2700
2969
|
| "rpc";
|
|
2701
2970
|
/**
|
|
@@ -2783,6 +3052,10 @@ export type PluginsReloadRequest = {
|
|
|
2783
3052
|
*/
|
|
2784
3053
|
deferRepoHooks?: boolean;
|
|
2785
3054
|
};
|
|
3055
|
+
/** @experimental */
|
|
3056
|
+
export type ProtocolAppendMode = "append";
|
|
3057
|
+
/** @experimental */
|
|
3058
|
+
export type ProtocolCustomizeMode = "customize";
|
|
2786
3059
|
/**
|
|
2787
3060
|
* Controls whether the runtime may defer loading an external tool definition.
|
|
2788
3061
|
*
|
|
@@ -2795,6 +3068,34 @@ export type ProtocolExternalToolDefer =
|
|
|
2795
3068
|
"auto"
|
|
2796
3069
|
/** The runtime must include the tool without deferring it. */
|
|
2797
3070
|
| "never";
|
|
3071
|
+
/** @experimental */
|
|
3072
|
+
export type ProtocolMarkerSectionOverride = {
|
|
3073
|
+
/**
|
|
3074
|
+
* Section override action discriminator.
|
|
3075
|
+
*/
|
|
3076
|
+
action: "transform";
|
|
3077
|
+
} | {
|
|
3078
|
+
/**
|
|
3079
|
+
* Section override action discriminator.
|
|
3080
|
+
*/
|
|
3081
|
+
action: "preserve";
|
|
3082
|
+
};
|
|
3083
|
+
/** @experimental */
|
|
3084
|
+
export type ProtocolReplaceMode = "replace";
|
|
3085
|
+
/** @experimental */
|
|
3086
|
+
export type ProtocolSectionOverride = ProtocolStaticSectionOverride | ProtocolMarkerSectionOverride;
|
|
3087
|
+
/** @experimental */
|
|
3088
|
+
export type ProtocolStaticSectionAction =
|
|
3089
|
+
/** Replace the section content. */
|
|
3090
|
+
"replace"
|
|
3091
|
+
/** Remove the section content. */
|
|
3092
|
+
| "remove"
|
|
3093
|
+
/** Append content to the section. */
|
|
3094
|
+
| "append"
|
|
3095
|
+
/** Prepend content to the section. */
|
|
3096
|
+
| "prepend";
|
|
3097
|
+
/** @experimental */
|
|
3098
|
+
export type ProtocolSystemMessageConfig = ProtocolSystemMessageAppendConfig | ProtocolSystemMessageReplaceConfig | ProtocolSystemMessageCustomizeConfig;
|
|
2798
3099
|
/**
|
|
2799
3100
|
* Provider family. Matches the `type` field of a BYOK provider config.
|
|
2800
3101
|
*
|
|
@@ -2960,6 +3261,32 @@ export type RemoteSessionMetadataTaskType =
|
|
|
2960
3261
|
"cca"
|
|
2961
3262
|
/** CLI remote task. */
|
|
2962
3263
|
| "cli";
|
|
3264
|
+
/**
|
|
3265
|
+
* Provider-native structured output format. JSON Schema is forwarded without rewriting or validating the schema or the generated output.
|
|
3266
|
+
*
|
|
3267
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3268
|
+
* via the `definition` "ResponseFormat".
|
|
3269
|
+
*/
|
|
3270
|
+
/** @experimental */
|
|
3271
|
+
export type ResponseFormat = {
|
|
3272
|
+
jsonSchema: JsonSchemaResponseFormat;
|
|
3273
|
+
/**
|
|
3274
|
+
* Output format discriminator. Currently only json_schema is supported.
|
|
3275
|
+
*/
|
|
3276
|
+
type: "json_schema";
|
|
3277
|
+
};
|
|
3278
|
+
/**
|
|
3279
|
+
* A session-scoped sandbox transition applied while handling a slash command
|
|
3280
|
+
*
|
|
3281
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3282
|
+
* via the `definition` "SandboxSessionChange".
|
|
3283
|
+
*/
|
|
3284
|
+
/** @experimental */
|
|
3285
|
+
export type SandboxSessionChange =
|
|
3286
|
+
/** The sandbox is off for the rest of this session; nothing was persisted and a new session starts from managed policy. */
|
|
3287
|
+
"disabled"
|
|
3288
|
+
/** A previous session-scoped opt-out was cleared and the sandbox is enforced again. */
|
|
3289
|
+
| "restored";
|
|
2963
3290
|
/**
|
|
2964
3291
|
* Current authentication information, or null when no authentication is active.
|
|
2965
3292
|
*
|
|
@@ -3917,81 +4244,284 @@ export type UISessionLimitsExhaustedResponseAction =
|
|
|
3917
4244
|
/** Leave the limit unchanged and cancel the blocked model request. */
|
|
3918
4245
|
| "cancel";
|
|
3919
4246
|
/**
|
|
3920
|
-
*
|
|
3921
|
-
*
|
|
3922
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3923
|
-
* via the `definition` "WorkspaceDiffFileChangeType".
|
|
3924
|
-
*/
|
|
3925
|
-
/** @experimental */
|
|
3926
|
-
export type WorkspaceDiffFileChangeType =
|
|
3927
|
-
/** The file was added. */
|
|
3928
|
-
"added"
|
|
3929
|
-
/** The file was modified. */
|
|
3930
|
-
| "modified"
|
|
3931
|
-
/** The file was deleted. */
|
|
3932
|
-
| "deleted"
|
|
3933
|
-
/** The file was renamed. */
|
|
3934
|
-
| "renamed";
|
|
3935
|
-
/**
|
|
3936
|
-
* Diff mode requested by the client.
|
|
3937
|
-
*
|
|
3938
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3939
|
-
* via the `definition` "WorkspaceDiffMode".
|
|
3940
|
-
*/
|
|
3941
|
-
/** @experimental */
|
|
3942
|
-
export type WorkspaceDiffMode =
|
|
3943
|
-
/** Return staged, unstaged, and untracked working tree changes. */
|
|
3944
|
-
"unstaged"
|
|
3945
|
-
/** Return changes compared with the default branch. */
|
|
3946
|
-
| "branch"
|
|
3947
|
-
/** Return the cumulative diff of files Copilot changed this session (used in non-git workspaces). */
|
|
3948
|
-
| "session";
|
|
3949
|
-
/**
|
|
3950
|
-
* Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration.
|
|
3951
|
-
*
|
|
3952
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3953
|
-
* via the `definition` "WorkspacesWorkspaceDetailsHostType".
|
|
3954
|
-
*/
|
|
3955
|
-
/** @experimental */
|
|
3956
|
-
export type WorkspacesWorkspaceDetailsHostType =
|
|
3957
|
-
/** Workspace repository is hosted on GitHub. */
|
|
3958
|
-
"github"
|
|
3959
|
-
/** Workspace repository is hosted on Azure DevOps. */
|
|
3960
|
-
| "ado";
|
|
3961
|
-
/**
|
|
3962
|
-
* List of all authenticated users
|
|
3963
|
-
*
|
|
3964
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3965
|
-
* via the `definition` "AccountGetAllUsersResult".
|
|
3966
|
-
*/
|
|
3967
|
-
/** @experimental */
|
|
3968
|
-
export type AccountGetAllUsersResult = AccountAllUsers[];
|
|
3969
|
-
/**
|
|
3970
|
-
* The number of running background agents (task-registry agents) that were cancelled.
|
|
4247
|
+
* Execution-critical workflow storage operation.
|
|
3971
4248
|
*
|
|
3972
4249
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3973
|
-
* via the `definition` "
|
|
4250
|
+
* via the `definition` "WorkflowDurableOperation".
|
|
3974
4251
|
*/
|
|
3975
4252
|
/** @experimental */
|
|
3976
|
-
export type
|
|
4253
|
+
export type WorkflowDurableOperation =
|
|
4254
|
+
/** Creating the durable run and declared phases. */
|
|
4255
|
+
"createRun"
|
|
4256
|
+
/** Persisting the transition to running. */
|
|
4257
|
+
| "markRunStarted"
|
|
4258
|
+
/** Persisting the terminal run envelope. */
|
|
4259
|
+
| "finishRun"
|
|
4260
|
+
/** Persisting subagent admission accounting. */
|
|
4261
|
+
| "reserveAgent"
|
|
4262
|
+
/** Rolling back an uncommitted subagent admission. */
|
|
4263
|
+
| "releaseAgent"
|
|
4264
|
+
/** Persisting an idempotent model-usage charge. */
|
|
4265
|
+
| "chargeCredit"
|
|
4266
|
+
/** Persisting active execution time. */
|
|
4267
|
+
| "addElapsed"
|
|
4268
|
+
/** Reading the authoritative AI-credit total. */
|
|
4269
|
+
| "reconcileCreditTotal"
|
|
4270
|
+
/** Reading a journal entry without treating storage failure as a cache miss. */
|
|
4271
|
+
| "journalGet"
|
|
4272
|
+
/** Persisting a journal entry before reporting success. */
|
|
4273
|
+
| "journalPut"
|
|
4274
|
+
/** Renewing the durable owner lease that proves this process still owns the run. */
|
|
4275
|
+
| "refreshLease";
|
|
3977
4276
|
/**
|
|
3978
|
-
*
|
|
4277
|
+
* Current or terminal state of a workflow run.
|
|
3979
4278
|
*
|
|
3980
4279
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3981
|
-
* via the `definition` "
|
|
4280
|
+
* via the `definition` "WorkflowRunStatus".
|
|
3982
4281
|
*/
|
|
3983
4282
|
/** @experimental */
|
|
3984
|
-
export type
|
|
4283
|
+
export type WorkflowRunStatus =
|
|
4284
|
+
/** The run was minted and is awaiting approval. */
|
|
4285
|
+
"pending"
|
|
4286
|
+
/** The run is executing. */
|
|
4287
|
+
| "running"
|
|
4288
|
+
/** The run completed successfully. */
|
|
4289
|
+
| "completed"
|
|
4290
|
+
/** The run was interrupted while resource budget remained. */
|
|
4291
|
+
| "halted"
|
|
4292
|
+
/** The current attempt stopped intentionally and the run may be resumed. */
|
|
4293
|
+
| "paused"
|
|
4294
|
+
/** The run was cancelled before completion. */
|
|
4295
|
+
| "cancelled"
|
|
4296
|
+
/** The workflow body failed or reached a cumulative resource ceiling. */
|
|
4297
|
+
| "error";
|
|
3985
4298
|
/**
|
|
3986
|
-
*
|
|
4299
|
+
* Machine-readable workflow run failure.
|
|
3987
4300
|
*
|
|
3988
4301
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3989
|
-
* via the `definition` "
|
|
4302
|
+
* via the `definition` "WorkflowRunFailure".
|
|
3990
4303
|
*/
|
|
3991
4304
|
/** @experimental */
|
|
3992
|
-
export type
|
|
3993
|
-
|
|
3994
|
-
|
|
4305
|
+
export type WorkflowRunFailure = {
|
|
4306
|
+
kind: WorkflowRunFailureKind;
|
|
4307
|
+
/**
|
|
4308
|
+
* Approved effective ceiling that was reached.
|
|
4309
|
+
*/
|
|
4310
|
+
value: number;
|
|
4311
|
+
/**
|
|
4312
|
+
* Suggested larger ceiling when the runtime can derive one safely.
|
|
4313
|
+
*/
|
|
4314
|
+
suggestedValue?: number;
|
|
4315
|
+
/**
|
|
4316
|
+
* Workflow run identifier.
|
|
4317
|
+
*/
|
|
4318
|
+
runId: string;
|
|
4319
|
+
/**
|
|
4320
|
+
* Workflow failure variant discriminator.
|
|
4321
|
+
*/
|
|
4322
|
+
type: "workflow_limit_reached";
|
|
4323
|
+
} | {
|
|
4324
|
+
/**
|
|
4325
|
+
* Workflow run identifier whose changed limits were declined.
|
|
4326
|
+
*/
|
|
4327
|
+
runId: string;
|
|
4328
|
+
/**
|
|
4329
|
+
* Human-readable reason the resume did not proceed.
|
|
4330
|
+
*/
|
|
4331
|
+
reason: string;
|
|
4332
|
+
/**
|
|
4333
|
+
* Workflow failure variant discriminator.
|
|
4334
|
+
*/
|
|
4335
|
+
type: "workflow_resume_declined";
|
|
4336
|
+
} | {
|
|
4337
|
+
/**
|
|
4338
|
+
* Stable failure code.
|
|
4339
|
+
*/
|
|
4340
|
+
code: string;
|
|
4341
|
+
operation: WorkflowDurableOperation;
|
|
4342
|
+
/**
|
|
4343
|
+
* Workflow run identifier.
|
|
4344
|
+
*/
|
|
4345
|
+
runId: string;
|
|
4346
|
+
/**
|
|
4347
|
+
* Workflow failure variant discriminator.
|
|
4348
|
+
*/
|
|
4349
|
+
type: "workflow_durable_failure";
|
|
4350
|
+
} | {
|
|
4351
|
+
/**
|
|
4352
|
+
* Workflow run identifier.
|
|
4353
|
+
*/
|
|
4354
|
+
runId: string;
|
|
4355
|
+
/**
|
|
4356
|
+
* Confirmed usage in nano-AIU, representing the floor of what the run spent.
|
|
4357
|
+
*/
|
|
4358
|
+
drainedNanoAiu: number;
|
|
4359
|
+
/**
|
|
4360
|
+
* Workflow failure variant discriminator.
|
|
4361
|
+
*/
|
|
4362
|
+
type: "workflow_accounting_incomplete";
|
|
4363
|
+
} | {
|
|
4364
|
+
/**
|
|
4365
|
+
* Workflow run identifier.
|
|
4366
|
+
*/
|
|
4367
|
+
runId: string;
|
|
4368
|
+
/**
|
|
4369
|
+
* Workflow failure variant discriminator.
|
|
4370
|
+
*/
|
|
4371
|
+
type: "workflow_provider_disconnected";
|
|
4372
|
+
};
|
|
4373
|
+
/**
|
|
4374
|
+
* Cumulative resource ceiling that stopped a workflow run.
|
|
4375
|
+
*
|
|
4376
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4377
|
+
* via the `definition` "WorkflowRunFailureKind".
|
|
4378
|
+
*/
|
|
4379
|
+
/** @experimental */
|
|
4380
|
+
export type WorkflowRunFailureKind =
|
|
4381
|
+
/** The run admitted the approved maximum total number of subagents. */
|
|
4382
|
+
"maxTotalSubagents"
|
|
4383
|
+
/** The run reached the approved accumulated active-execution time in seconds. */
|
|
4384
|
+
| "timeoutSeconds"
|
|
4385
|
+
/** The run's settled subagent model usage exceeded the approved AI-credit ceiling, or no headroom remained for another subagent. */
|
|
4386
|
+
| "maxAiCredits";
|
|
4387
|
+
/**
|
|
4388
|
+
* Durable metadata describing who initiated a workflow pause.
|
|
4389
|
+
*
|
|
4390
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4391
|
+
* via the `definition` "WorkflowPauseInfo".
|
|
4392
|
+
*/
|
|
4393
|
+
/** @experimental */
|
|
4394
|
+
export type WorkflowPauseInfo = {
|
|
4395
|
+
/**
|
|
4396
|
+
* Workflow pause initiator discriminator.
|
|
4397
|
+
*/
|
|
4398
|
+
type: "user";
|
|
4399
|
+
} | {
|
|
4400
|
+
/**
|
|
4401
|
+
* Stable author-defined checkpoint key that initiated the pause.
|
|
4402
|
+
*/
|
|
4403
|
+
key: string;
|
|
4404
|
+
/**
|
|
4405
|
+
* Workflow pause initiator discriminator.
|
|
4406
|
+
*/
|
|
4407
|
+
type: "checkpoint";
|
|
4408
|
+
};
|
|
4409
|
+
/**
|
|
4410
|
+
* Kind of workflow progress line.
|
|
4411
|
+
*
|
|
4412
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4413
|
+
* via the `definition` "WorkflowLogLineKind".
|
|
4414
|
+
*/
|
|
4415
|
+
/** @experimental */
|
|
4416
|
+
export type WorkflowLogLineKind =
|
|
4417
|
+
/** A narrator log line. */
|
|
4418
|
+
"log"
|
|
4419
|
+
/** A named workflow phase marker. */
|
|
4420
|
+
| "phase";
|
|
4421
|
+
/**
|
|
4422
|
+
* Action the runtime selected for a durable workflow pause checkpoint.
|
|
4423
|
+
*
|
|
4424
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4425
|
+
* via the `definition` "WorkflowPauseCheckpointAction".
|
|
4426
|
+
*/
|
|
4427
|
+
/** @experimental */
|
|
4428
|
+
export type WorkflowPauseCheckpointAction =
|
|
4429
|
+
/** The checkpoint was committed by a prior paused attempt, so execution may continue. */
|
|
4430
|
+
"continue"
|
|
4431
|
+
/** This attempt claimed the checkpoint and must cooperatively stop. */
|
|
4432
|
+
| "pause";
|
|
4433
|
+
/**
|
|
4434
|
+
* Derived lifecycle state of a workflow phase.
|
|
4435
|
+
*
|
|
4436
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4437
|
+
* via the `definition` "WorkflowPhaseStatus".
|
|
4438
|
+
*/
|
|
4439
|
+
/** @experimental */
|
|
4440
|
+
export type WorkflowPhaseStatus =
|
|
4441
|
+
/** The phase has not been entered yet. */
|
|
4442
|
+
"pending"
|
|
4443
|
+
/** The phase is currently entered and accumulating active time. */
|
|
4444
|
+
| "active"
|
|
4445
|
+
/** The phase was entered and has since been closed. */
|
|
4446
|
+
| "completed"
|
|
4447
|
+
/** The phase was never entered because a later phase was entered or the run reached a terminal state. */
|
|
4448
|
+
| "skipped";
|
|
4449
|
+
/**
|
|
4450
|
+
* Type of change represented by this file diff.
|
|
4451
|
+
*
|
|
4452
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4453
|
+
* via the `definition` "WorkspaceDiffFileChangeType".
|
|
4454
|
+
*/
|
|
4455
|
+
/** @experimental */
|
|
4456
|
+
export type WorkspaceDiffFileChangeType =
|
|
4457
|
+
/** The file was added. */
|
|
4458
|
+
"added"
|
|
4459
|
+
/** The file was modified. */
|
|
4460
|
+
| "modified"
|
|
4461
|
+
/** The file was deleted. */
|
|
4462
|
+
| "deleted"
|
|
4463
|
+
/** The file was renamed. */
|
|
4464
|
+
| "renamed";
|
|
4465
|
+
/**
|
|
4466
|
+
* Diff mode requested by the client.
|
|
4467
|
+
*
|
|
4468
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4469
|
+
* via the `definition` "WorkspaceDiffMode".
|
|
4470
|
+
*/
|
|
4471
|
+
/** @experimental */
|
|
4472
|
+
export type WorkspaceDiffMode =
|
|
4473
|
+
/** Return staged, unstaged, and untracked working tree changes. */
|
|
4474
|
+
"unstaged"
|
|
4475
|
+
/** Return changes compared with the default branch. */
|
|
4476
|
+
| "branch"
|
|
4477
|
+
/** Return the cumulative diff of files Copilot changed this session (used in non-git workspaces). */
|
|
4478
|
+
| "session";
|
|
4479
|
+
/**
|
|
4480
|
+
* Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration.
|
|
4481
|
+
*
|
|
4482
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4483
|
+
* via the `definition` "WorkspacesWorkspaceDetailsHostType".
|
|
4484
|
+
*/
|
|
4485
|
+
/** @experimental */
|
|
4486
|
+
export type WorkspacesWorkspaceDetailsHostType =
|
|
4487
|
+
/** Workspace repository is hosted on GitHub. */
|
|
4488
|
+
"github"
|
|
4489
|
+
/** Workspace repository is hosted on Azure DevOps. */
|
|
4490
|
+
| "ado";
|
|
4491
|
+
/**
|
|
4492
|
+
* List of all authenticated users
|
|
4493
|
+
*
|
|
4494
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4495
|
+
* via the `definition` "AccountGetAllUsersResult".
|
|
4496
|
+
*/
|
|
4497
|
+
/** @experimental */
|
|
4498
|
+
export type AccountGetAllUsersResult = AccountAllUsers[];
|
|
4499
|
+
/**
|
|
4500
|
+
* The number of running background agents (task-registry agents) that were cancelled.
|
|
4501
|
+
*
|
|
4502
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4503
|
+
* via the `definition` "SessionCancelAllBackgroundAgentsResult".
|
|
4504
|
+
*/
|
|
4505
|
+
/** @experimental */
|
|
4506
|
+
export type SessionCancelAllBackgroundAgentsResult = number;
|
|
4507
|
+
/**
|
|
4508
|
+
* Authentication accounts available to the internal session host.
|
|
4509
|
+
*
|
|
4510
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4511
|
+
* via the `definition` "SessionGitHubAuthGetAllAuthAvailableResult".
|
|
4512
|
+
*/
|
|
4513
|
+
/** @experimental */
|
|
4514
|
+
export type SessionGitHubAuthGetAllAuthAvailableResult = SessionAuthStatus[];
|
|
4515
|
+
/**
|
|
4516
|
+
* Whether the current authentication was logged out.
|
|
4517
|
+
*
|
|
4518
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4519
|
+
* via the `definition` "SessionGitHubAuthLogoutResult".
|
|
4520
|
+
*/
|
|
4521
|
+
/** @experimental */
|
|
4522
|
+
export type SessionGitHubAuthLogoutResult = boolean;
|
|
4523
|
+
/**
|
|
4524
|
+
* Whether the requested authentication was logged out.
|
|
3995
4525
|
*
|
|
3996
4526
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
3997
4527
|
* via the `definition` "SessionGitHubAuthLogoutUserResult".
|
|
@@ -4025,6 +4555,17 @@ export interface AbortResult {
|
|
|
4025
4555
|
*/
|
|
4026
4556
|
error?: string;
|
|
4027
4557
|
}
|
|
4558
|
+
/** @experimental */
|
|
4559
|
+
export interface AcceptedEnqueueCommandResult {
|
|
4560
|
+
/**
|
|
4561
|
+
* True because the command was accepted into the local execution queue.
|
|
4562
|
+
*/
|
|
4563
|
+
queued: true;
|
|
4564
|
+
/**
|
|
4565
|
+
* Stable opaque ID of the queued command.
|
|
4566
|
+
*/
|
|
4567
|
+
queueId: string;
|
|
4568
|
+
}
|
|
4028
4569
|
/**
|
|
4029
4570
|
* Authenticated account entry returned by `account.getAllUsers`.
|
|
4030
4571
|
*
|
|
@@ -4135,6 +4676,15 @@ export interface CopilotUserResponse {
|
|
|
4135
4676
|
[k: string]: unknown | undefined;
|
|
4136
4677
|
} | string) | null;
|
|
4137
4678
|
} | null)[]) | null;
|
|
4679
|
+
/**
|
|
4680
|
+
* Enterprises that provide the user's Copilot license; malformed entries are normalized to null or ID-less shapes.
|
|
4681
|
+
*/
|
|
4682
|
+
enterprise_list?: ({
|
|
4683
|
+
/**
|
|
4684
|
+
* JavaScript-safe numeric database ID of the enterprise.
|
|
4685
|
+
*/
|
|
4686
|
+
id?: number;
|
|
4687
|
+
} | null)[] | null;
|
|
4138
4688
|
/**
|
|
4139
4689
|
* Whether the Codex agent is enabled for the user.
|
|
4140
4690
|
*/
|
|
@@ -4768,7 +5318,7 @@ export interface AgentGetCurrentResult {
|
|
|
4768
5318
|
agent?: AgentInfo | null;
|
|
4769
5319
|
}
|
|
4770
5320
|
/**
|
|
4771
|
-
* Agent metadata, including identifiers, display details, source, tools, model, models, MCP servers, skills, and file path.
|
|
5321
|
+
* Agent metadata, including identifiers, display details, source, tools, model, models, reasoning effort, MCP servers, skills, and file path.
|
|
4772
5322
|
*
|
|
4773
5323
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4774
5324
|
* via the `definition` "AgentInfo".
|
|
@@ -4817,6 +5367,10 @@ export interface AgentInfo {
|
|
|
4817
5367
|
*/
|
|
4818
5368
|
models?: string[];
|
|
4819
5369
|
modelPolicy?: AgentModelPolicy;
|
|
5370
|
+
/**
|
|
5371
|
+
* Authored reasoning effort for this agent. Applied on selection to models that support it; omitted means no authored preference.
|
|
5372
|
+
*/
|
|
5373
|
+
reasoningEffort?: string;
|
|
4820
5374
|
/**
|
|
4821
5375
|
* MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema.
|
|
4822
5376
|
*
|
|
@@ -4913,7 +5467,7 @@ export interface AgentRegistryLiveTargetEntry {
|
|
|
4913
5467
|
lastSeenMs: number;
|
|
4914
5468
|
}
|
|
4915
5469
|
/**
|
|
4916
|
-
*
|
|
5470
|
+
* Canonical process-log discovery outcome; populated from spawnLiveTarget.
|
|
4917
5471
|
*
|
|
4918
5472
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4919
5473
|
* via the `definition` "AgentRegistryLogCapture".
|
|
@@ -4921,15 +5475,15 @@ export interface AgentRegistryLiveTargetEntry {
|
|
|
4921
5475
|
/** @experimental */
|
|
4922
5476
|
export interface AgentRegistryLogCapture {
|
|
4923
5477
|
/**
|
|
4924
|
-
* Whether
|
|
5478
|
+
* Whether a canonical process log was discovered for this managed spawn
|
|
4925
5479
|
*/
|
|
4926
5480
|
enabled: boolean;
|
|
4927
5481
|
/**
|
|
4928
|
-
* Absolute path to the
|
|
5482
|
+
* Absolute path to the managed spawn's process-<timestamp>-<pid>.log file (only set when enabled)
|
|
4929
5483
|
*/
|
|
4930
5484
|
path?: string;
|
|
4931
5485
|
/**
|
|
4932
|
-
*
|
|
5486
|
+
* Why no canonical process log could be opened for this managed spawn (set only when enabled is false)
|
|
4933
5487
|
*/
|
|
4934
5488
|
openError?: string;
|
|
4935
5489
|
openErrorReason?: AgentRegistryLogCaptureOpenErrorReason;
|
|
@@ -5772,33 +6326,17 @@ export interface CardDigest {
|
|
|
5772
6326
|
value: CardDigestValue;
|
|
5773
6327
|
}
|
|
5774
6328
|
/**
|
|
5775
|
-
* An inert
|
|
6329
|
+
* An inert Agent Plugin catalog result. Its canonical catalog identity, declared version, repository source claim, and explicit compatibility tags are safe to correlate, while its descriptor, URL, raw data, and installed-plugin state remain runtime-private. This contract-only variant does not mint or expose a candidate handle.
|
|
5776
6330
|
*
|
|
5777
6331
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5778
|
-
* via the `definition` "
|
|
6332
|
+
* via the `definition` "CatalogAgentPluginCandidate".
|
|
5779
6333
|
*/
|
|
5780
6334
|
/** @experimental */
|
|
5781
|
-
export interface
|
|
5782
|
-
|
|
5783
|
-
|
|
5784
|
-
|
|
5785
|
-
|
|
5786
|
-
/**
|
|
5787
|
-
* ISO 8601 timestamp after which the handle is stale and will be rejected.
|
|
5788
|
-
*/
|
|
5789
|
-
handleExpiresAt: string;
|
|
5790
|
-
/**
|
|
5791
|
-
* Discriminator: this candidate describes an AI skill
|
|
5792
|
-
*/
|
|
5793
|
-
kind: "ai-skill";
|
|
5794
|
-
/**
|
|
5795
|
-
* Media type of the underlying AI skill card
|
|
5796
|
-
*/
|
|
5797
|
-
mediaType: "application/ai-skill";
|
|
5798
|
-
/**
|
|
5799
|
-
* AI skills are discovery-only and cannot be installed through this surface
|
|
5800
|
-
*/
|
|
5801
|
-
installability: "not-installable-kind";
|
|
6335
|
+
export interface CatalogAgentPluginCandidate {
|
|
6336
|
+
kind: CatalogAgentPluginCandidateKind;
|
|
6337
|
+
mediaType: CatalogAgentPluginMediaType;
|
|
6338
|
+
identity: CatalogResourceIdentity;
|
|
6339
|
+
version?: CatalogResourceVersion;
|
|
5802
6340
|
/**
|
|
5803
6341
|
* Display name taken verbatim from the card. Inert untrusted text.
|
|
5804
6342
|
*/
|
|
@@ -5811,48 +6349,43 @@ export interface CatalogAiSkillCandidate {
|
|
|
5811
6349
|
* Publisher taken verbatim from the card. Inert untrusted text.
|
|
5812
6350
|
*/
|
|
5813
6351
|
publisher?: string;
|
|
5814
|
-
source:
|
|
5815
|
-
|
|
6352
|
+
source: CatalogPluginRepositorySource;
|
|
6353
|
+
/**
|
|
6354
|
+
* Explicit validated compatibility tags, in canonical order. An empty list means the source declared no recognised compatibility; clients must not infer compatibility from other fields. `canvas-only` requires both `canvas` and `github-copilot`.
|
|
6355
|
+
*
|
|
6356
|
+
* @maxItems 3
|
|
6357
|
+
*/
|
|
6358
|
+
compatibilityTags: ({
|
|
6359
|
+
[k: string]: unknown | undefined;
|
|
6360
|
+
} & []) | [CatalogAgentPluginCompatibilityTag] | [CatalogAgentPluginCompatibilityTag, CatalogAgentPluginCompatibilityTag] | [CatalogAgentPluginCompatibilityTag, CatalogAgentPluginCompatibilityTag, CatalogAgentPluginCompatibilityTag];
|
|
6361
|
+
provenance: CatalogAgentPluginCandidateProvenance;
|
|
5816
6362
|
trust?: CatalogTrustSnapshot;
|
|
5817
6363
|
}
|
|
5818
6364
|
/**
|
|
5819
|
-
*
|
|
6365
|
+
* Syntactically validated GitHub repository provenance declared by catalog metadata. This is a source claim rather than proof that the descriptor URL resolves to the repository.
|
|
5820
6366
|
*
|
|
5821
6367
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5822
|
-
* via the `definition` "
|
|
6368
|
+
* via the `definition` "CatalogPluginRepositorySource".
|
|
5823
6369
|
*/
|
|
5824
6370
|
/** @experimental */
|
|
5825
|
-
export interface
|
|
6371
|
+
export interface CatalogPluginRepositorySource {
|
|
5826
6372
|
/**
|
|
5827
|
-
*
|
|
5828
|
-
*/
|
|
5829
|
-
kind: "url";
|
|
5830
|
-
/**
|
|
5831
|
-
* Card URL as advertised. Inert untrusted data: the runtime retrieves it only through its own hardened boundary, and it is never logged.
|
|
6373
|
+
* Canonical lowercase owner/repository name derived from metadata.sourceSet.
|
|
5832
6374
|
*/
|
|
5833
|
-
|
|
5834
|
-
}
|
|
5835
|
-
/**
|
|
5836
|
-
* Candidate whose card reference arrived inline. The document and its content-derived properties stay behind the runtime boundary.
|
|
5837
|
-
*
|
|
5838
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5839
|
-
* via the `definition` "CatalogCandidateSourceEmbedded".
|
|
5840
|
-
*/
|
|
5841
|
-
/** @experimental */
|
|
5842
|
-
export interface CatalogCandidateSourceEmbedded {
|
|
6375
|
+
repository: string;
|
|
5843
6376
|
/**
|
|
5844
|
-
*
|
|
6377
|
+
* Case-preserving safe relative POSIX path derived from metadata.repoPath.
|
|
5845
6378
|
*/
|
|
5846
|
-
|
|
6379
|
+
path: string;
|
|
5847
6380
|
}
|
|
5848
6381
|
/**
|
|
5849
|
-
* Where and when an
|
|
6382
|
+
* Where and when an Agent Plugin catalog reference was observed. Discovery provenance deliberately carries no descriptor URL, raw data, candidate handle, or content digest.
|
|
5850
6383
|
*
|
|
5851
6384
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5852
|
-
* via the `definition` "
|
|
6385
|
+
* via the `definition` "CatalogAgentPluginCandidateProvenance".
|
|
5853
6386
|
*/
|
|
5854
6387
|
/** @experimental */
|
|
5855
|
-
export interface
|
|
6388
|
+
export interface CatalogAgentPluginCandidateProvenance {
|
|
5856
6389
|
/**
|
|
5857
6390
|
* Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data.
|
|
5858
6391
|
*/
|
|
@@ -5861,10 +6394,7 @@ export interface CatalogAiSkillCandidateProvenance {
|
|
|
5861
6394
|
* ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp.
|
|
5862
6395
|
*/
|
|
5863
6396
|
observedAt: string;
|
|
5864
|
-
|
|
5865
|
-
* Media type advertised for the referenced AI skill card
|
|
5866
|
-
*/
|
|
5867
|
-
mediaType: "application/ai-skill";
|
|
6397
|
+
mediaType: CatalogAgentPluginMediaType;
|
|
5868
6398
|
}
|
|
5869
6399
|
/**
|
|
5870
6400
|
* A recognised current Agent Finder T1 or T2 trust tier.
|
|
@@ -5973,17 +6503,100 @@ export interface CatalogTrustSnapshotMalformed {
|
|
|
5973
6503
|
provenance: CatalogTrustProvenance;
|
|
5974
6504
|
}
|
|
5975
6505
|
/**
|
|
5976
|
-
* An
|
|
6506
|
+
* An inert AI skill catalog result. AI skills are discovery-only and cannot be represented as installable through this surface.
|
|
5977
6507
|
*
|
|
5978
6508
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5979
|
-
* via the `definition` "
|
|
6509
|
+
* via the `definition` "CatalogAiSkillCandidate".
|
|
5980
6510
|
*/
|
|
5981
6511
|
/** @experimental */
|
|
5982
|
-
export interface
|
|
6512
|
+
export interface CatalogAiSkillCandidate {
|
|
5983
6513
|
/**
|
|
5984
|
-
*
|
|
6514
|
+
* Opaque, runtime-instance scoped, TTL-bound, single-use handle for this candidate. Carries no readable information and is rejected when stale, replayed, or presented to a different runtime instance. Never logged.
|
|
5985
6515
|
*/
|
|
5986
|
-
|
|
6516
|
+
handle: string;
|
|
6517
|
+
/**
|
|
6518
|
+
* ISO 8601 timestamp after which the handle is stale and will be rejected.
|
|
6519
|
+
*/
|
|
6520
|
+
handleExpiresAt: string;
|
|
6521
|
+
kind: CatalogAiSkillCandidateKind;
|
|
6522
|
+
mediaType: CatalogAiSkillMediaType;
|
|
6523
|
+
installability: CatalogAiSkillInstallability;
|
|
6524
|
+
/**
|
|
6525
|
+
* Display name taken verbatim from the card. Inert untrusted text.
|
|
6526
|
+
*/
|
|
6527
|
+
displayName: string;
|
|
6528
|
+
/**
|
|
6529
|
+
* Description taken verbatim from the card. Inert untrusted text.
|
|
6530
|
+
*/
|
|
6531
|
+
description?: string;
|
|
6532
|
+
/**
|
|
6533
|
+
* Publisher taken verbatim from the card. Inert untrusted text.
|
|
6534
|
+
*/
|
|
6535
|
+
publisher?: string;
|
|
6536
|
+
source: CatalogCandidateSource;
|
|
6537
|
+
provenance: CatalogAiSkillCandidateProvenance;
|
|
6538
|
+
trust?: CatalogTrustSnapshot;
|
|
6539
|
+
}
|
|
6540
|
+
/**
|
|
6541
|
+
* Candidate whose card is retrieved from a URL through the runtime's hardened fetch boundary.
|
|
6542
|
+
*
|
|
6543
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6544
|
+
* via the `definition` "CatalogCandidateSourceUrl".
|
|
6545
|
+
*/
|
|
6546
|
+
/** @experimental */
|
|
6547
|
+
export interface CatalogCandidateSourceUrl {
|
|
6548
|
+
/**
|
|
6549
|
+
* Discriminator: the card is URL-backed, and carries no embedded data
|
|
6550
|
+
*/
|
|
6551
|
+
kind: "url";
|
|
6552
|
+
/**
|
|
6553
|
+
* Card URL as advertised. Inert untrusted data: the runtime retrieves it only through its own hardened boundary, and it is never logged.
|
|
6554
|
+
*/
|
|
6555
|
+
url: string;
|
|
6556
|
+
}
|
|
6557
|
+
/**
|
|
6558
|
+
* Candidate whose card reference arrived inline. The document and its content-derived properties stay behind the runtime boundary.
|
|
6559
|
+
*
|
|
6560
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6561
|
+
* via the `definition` "CatalogCandidateSourceEmbedded".
|
|
6562
|
+
*/
|
|
6563
|
+
/** @experimental */
|
|
6564
|
+
export interface CatalogCandidateSourceEmbedded {
|
|
6565
|
+
/**
|
|
6566
|
+
* Discriminator: the card is embedded, and carries no URL
|
|
6567
|
+
*/
|
|
6568
|
+
kind: "embedded";
|
|
6569
|
+
}
|
|
6570
|
+
/**
|
|
6571
|
+
* Where and when an AI skill catalog reference was observed. Discovery provenance deliberately carries no content digest because search does not establish the exact validated content a later plan will bind.
|
|
6572
|
+
*
|
|
6573
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6574
|
+
* via the `definition` "CatalogAiSkillCandidateProvenance".
|
|
6575
|
+
*/
|
|
6576
|
+
/** @experimental */
|
|
6577
|
+
export interface CatalogAiSkillCandidateProvenance {
|
|
6578
|
+
/**
|
|
6579
|
+
* Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data.
|
|
6580
|
+
*/
|
|
6581
|
+
authority: string;
|
|
6582
|
+
/**
|
|
6583
|
+
* ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp.
|
|
6584
|
+
*/
|
|
6585
|
+
observedAt: string;
|
|
6586
|
+
mediaType: CatalogAiSkillMediaType;
|
|
6587
|
+
}
|
|
6588
|
+
/**
|
|
6589
|
+
* An optional catalog authentication exchange did not establish the caller's identity. Anonymous search remains supported; this refusal is reserved for an operation that cannot continue after the attempted exchange. It is distinct from `policy-rejected` and from a network failure, and the reason identifies the recovery action.
|
|
6590
|
+
*
|
|
6591
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6592
|
+
* via the `definition` "CatalogAuthenticationRequiredError".
|
|
6593
|
+
*/
|
|
6594
|
+
/** @experimental */
|
|
6595
|
+
export interface CatalogAuthenticationRequiredError {
|
|
6596
|
+
/**
|
|
6597
|
+
* Discriminator: the caller is not authenticated
|
|
6598
|
+
*/
|
|
6599
|
+
kind: "authentication-required";
|
|
5987
6600
|
reason: CatalogAuthenticationRequiredReason;
|
|
5988
6601
|
/**
|
|
5989
6602
|
* Human-readable explanation, safe to surface. Never contains a credential or token, nor a query, URL, handle, or secret.
|
|
@@ -6006,10 +6619,7 @@ export interface CatalogMcpServerCandidate {
|
|
|
6006
6619
|
* ISO 8601 timestamp after which the handle is stale and will be rejected.
|
|
6007
6620
|
*/
|
|
6008
6621
|
handleExpiresAt: string;
|
|
6009
|
-
|
|
6010
|
-
* Discriminator: this candidate describes an MCP server
|
|
6011
|
-
*/
|
|
6012
|
-
kind: "mcp-server";
|
|
6622
|
+
kind: CatalogMcpServerCandidateKind;
|
|
6013
6623
|
mediaType: McpServerCardMediaType;
|
|
6014
6624
|
installability: CatalogMcpServerInstallability;
|
|
6015
6625
|
/**
|
|
@@ -6103,7 +6713,7 @@ export interface CatalogHandleRejectedError {
|
|
|
6103
6713
|
message: string;
|
|
6104
6714
|
}
|
|
6105
6715
|
/**
|
|
6106
|
-
* The request was rejected
|
|
6716
|
+
* The request was rejected because a bounded field fell outside its permitted range or a required field was unusable. Pagination may also be rejected by the authority after a continuation request; repeat the search without page.
|
|
6107
6717
|
*
|
|
6108
6718
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6109
6719
|
* via the `definition` "CatalogInvalidRequestError".
|
|
@@ -6152,7 +6762,7 @@ export interface CatalogNegotiatedContract {
|
|
|
6152
6762
|
*/
|
|
6153
6763
|
runtimeProtocolVersion: number;
|
|
6154
6764
|
/**
|
|
6155
|
-
* Wire features the runtime understood for this operation. Always a superset of the caller's required features, because any shortfall is a refusal instead. Operation availability remains a separate typed result.
|
|
6765
|
+
* Wire features the runtime understood for this operation. Includes the five original catalog capabilities and only explicitly requested supported additions, in supported order without duplicates. Capabilities that introduce new success-union variants or operations are therefore included only when explicitly required, preserving older protocol-v3 clients. Always a superset of the caller's required features, because any shortfall is a refusal instead. Operation availability remains a separate typed result.
|
|
6156
6766
|
*/
|
|
6157
6767
|
grantedCapabilities: CatalogCapability[];
|
|
6158
6768
|
}
|
|
@@ -6256,6 +6866,61 @@ export interface CatalogPolicyRejectedError {
|
|
|
6256
6866
|
*/
|
|
6257
6867
|
message: string;
|
|
6258
6868
|
}
|
|
6869
|
+
/**
|
|
6870
|
+
* An explicit numbered-page request. The SDK treats the token as opaque; only the runtime decodes it and changes its targetPage. Authority validation binds navigation to the original search. No snapshot stability or token TTL is promised.
|
|
6871
|
+
*
|
|
6872
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6873
|
+
* via the `definition` "CatalogSearchPage".
|
|
6874
|
+
*/
|
|
6875
|
+
/** @experimental */
|
|
6876
|
+
export interface CatalogSearchPage {
|
|
6877
|
+
/**
|
|
6878
|
+
* Opaque authority-issued pagination token from an earlier response. Never decode, modify or log it in an SDK consumer.
|
|
6879
|
+
*/
|
|
6880
|
+
token: string;
|
|
6881
|
+
/**
|
|
6882
|
+
* Requested one-based page. Must not exceed either the token's signed pageCount or the navigation window ceil(1000 / pageSize). Repeat the search without page to discover newly available pages beyond that signed pageCount.
|
|
6883
|
+
*/
|
|
6884
|
+
number: number;
|
|
6885
|
+
}
|
|
6886
|
+
/**
|
|
6887
|
+
* Authority-reported navigation metadata, returned only to callers requiring catalog-search-pagination and only when a supported token is present. Tokenless first-page and continuation responses omit this object; no counts are inferred from candidates. The opaque token may be retained for previous or numbered navigation even when hasNextPage is false.
|
|
6888
|
+
*
|
|
6889
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6890
|
+
* via the `definition` "CatalogSearchPagination".
|
|
6891
|
+
*/
|
|
6892
|
+
/** @experimental */
|
|
6893
|
+
export interface CatalogSearchPagination {
|
|
6894
|
+
/**
|
|
6895
|
+
* Opaque authority-issued pagination token. Only the runtime decodes it or changes targetPage; SDK consumers must not decode, modify or log it. It has no runtime-created expiry or cache.
|
|
6896
|
+
*/
|
|
6897
|
+
token: string;
|
|
6898
|
+
/**
|
|
6899
|
+
* One-based page returned by the authority.
|
|
6900
|
+
*/
|
|
6901
|
+
currentPage: number;
|
|
6902
|
+
/**
|
|
6903
|
+
* Page size bound to the search, equal to the effective request limit.
|
|
6904
|
+
*/
|
|
6905
|
+
pageSize: number;
|
|
6906
|
+
/**
|
|
6907
|
+
* Backend-reported count for this response, not the number of returned candidates. Its relationship to the full query result set is unknown.
|
|
6908
|
+
*/
|
|
6909
|
+
totalCount: number;
|
|
6910
|
+
totalCountRelation: CatalogSearchTotalCountRelation;
|
|
6911
|
+
/**
|
|
6912
|
+
* Backend-reported page count, which may exceed maxPage. Present pagination metadata always describes a multi-page result; zero- and single-page responses omit pagination. Navigation targets must also be within the signed pageCount carried by the supplied token.
|
|
6913
|
+
*/
|
|
6914
|
+
pageCount: number;
|
|
6915
|
+
/**
|
|
6916
|
+
* Navigation window ceiling ceil(1000 / pageSize), not the number of existing pages. Legal targets must not exceed this ceiling or the token's signed pageCount.
|
|
6917
|
+
*/
|
|
6918
|
+
maxPage: number;
|
|
6919
|
+
/**
|
|
6920
|
+
* Whether the authority token advertises a valid next target within the navigation window. Not inferred from token presence, truncated, or currentPage being less than pageCount.
|
|
6921
|
+
*/
|
|
6922
|
+
hasNextPage: boolean;
|
|
6923
|
+
}
|
|
6259
6924
|
/**
|
|
6260
6925
|
* A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan.
|
|
6261
6926
|
*
|
|
@@ -6274,15 +6939,16 @@ export interface CatalogSearchRequest {
|
|
|
6274
6939
|
*/
|
|
6275
6940
|
limit?: number;
|
|
6276
6941
|
/**
|
|
6277
|
-
* Restrict results to these candidate kinds.
|
|
6942
|
+
* Restrict results to these candidate kinds. Agent Plugins are opt-in and require the `agent-plugin-discovery` capability so protocol-v3 clients generated before that variant cannot receive an unknown result; when omitted, the backwards-compatible MCP server and AI skill kinds are searched.
|
|
6278
6943
|
*
|
|
6279
6944
|
* @minItems 1
|
|
6280
|
-
* @maxItems
|
|
6945
|
+
* @maxItems 3
|
|
6281
6946
|
*/
|
|
6282
|
-
kinds?: [CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind];
|
|
6947
|
+
kinds?: [CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind, CatalogCandidateKind];
|
|
6948
|
+
page?: CatalogSearchPage;
|
|
6283
6949
|
}
|
|
6284
6950
|
/**
|
|
6285
|
-
* A completed catalog search
|
|
6951
|
+
* A completed catalog search containing inert candidate summaries. MCP server and AI skill variants carry a single-use handle; the Agent Plugin variant is handleless.
|
|
6286
6952
|
*
|
|
6287
6953
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6288
6954
|
* via the `definition` "CatalogSearchSucceeded".
|
|
@@ -6304,10 +6970,11 @@ export interface CatalogSearchSucceeded {
|
|
|
6304
6970
|
*/
|
|
6305
6971
|
candidates: CatalogCandidate[];
|
|
6306
6972
|
/**
|
|
6307
|
-
*
|
|
6973
|
+
* Legacy indication that the authority returned a page token. Preserved for compatibility; this is not a has-next-page indicator. Use pagination.hasNextPage when pagination metadata is present.
|
|
6308
6974
|
*/
|
|
6309
6975
|
truncated: boolean;
|
|
6310
6976
|
negotiated: CatalogNegotiatedContract;
|
|
6977
|
+
pagination?: CatalogSearchPagination;
|
|
6311
6978
|
}
|
|
6312
6979
|
/**
|
|
6313
6980
|
* The request asked for a candidate kind this runtime does not serve.
|
|
@@ -6370,6 +7037,182 @@ export interface CatalogUnavailableError {
|
|
|
6370
7037
|
*/
|
|
6371
7038
|
message: string;
|
|
6372
7039
|
}
|
|
7040
|
+
/**
|
|
7041
|
+
* The caller cancelled the selection interaction and the retained search state was released.
|
|
7042
|
+
*
|
|
7043
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7044
|
+
* via the `definition` "CatalogSelectionCancelled".
|
|
7045
|
+
*/
|
|
7046
|
+
/** @experimental */
|
|
7047
|
+
export interface CatalogSelectionCancelled {
|
|
7048
|
+
/**
|
|
7049
|
+
* Discriminator: selection was cancelled
|
|
7050
|
+
*/
|
|
7051
|
+
kind: "cancelled";
|
|
7052
|
+
/**
|
|
7053
|
+
* The search identifier privately bound to the released selection group.
|
|
7054
|
+
*/
|
|
7055
|
+
searchId: string;
|
|
7056
|
+
}
|
|
7057
|
+
/**
|
|
7058
|
+
* The caller explicitly declined every candidate and the retained search state was released.
|
|
7059
|
+
*
|
|
7060
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7061
|
+
* via the `definition` "CatalogSelectionDeclined".
|
|
7062
|
+
*/
|
|
7063
|
+
/** @experimental */
|
|
7064
|
+
export interface CatalogSelectionDeclined {
|
|
7065
|
+
/**
|
|
7066
|
+
* Discriminator: the candidates were declined
|
|
7067
|
+
*/
|
|
7068
|
+
kind: "declined";
|
|
7069
|
+
/**
|
|
7070
|
+
* The search identifier privately bound to the released selection group.
|
|
7071
|
+
*/
|
|
7072
|
+
searchId: string;
|
|
7073
|
+
}
|
|
7074
|
+
/**
|
|
7075
|
+
* The selection reference belongs to another runtime instance or session.
|
|
7076
|
+
*
|
|
7077
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7078
|
+
* via the `definition` "CatalogSelectionForeign".
|
|
7079
|
+
*/
|
|
7080
|
+
/** @experimental */
|
|
7081
|
+
export interface CatalogSelectionForeign {
|
|
7082
|
+
/**
|
|
7083
|
+
* Discriminator for this typed selection rejection
|
|
7084
|
+
*/
|
|
7085
|
+
kind: "foreign";
|
|
7086
|
+
/**
|
|
7087
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
7088
|
+
*/
|
|
7089
|
+
message: string;
|
|
7090
|
+
}
|
|
7091
|
+
/**
|
|
7092
|
+
* The selection reference was malformed or unknown.
|
|
7093
|
+
*
|
|
7094
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7095
|
+
* via the `definition` "CatalogSelectionInvalid".
|
|
7096
|
+
*/
|
|
7097
|
+
/** @experimental */
|
|
7098
|
+
export interface CatalogSelectionInvalid {
|
|
7099
|
+
/**
|
|
7100
|
+
* Discriminator for this typed selection rejection
|
|
7101
|
+
*/
|
|
7102
|
+
kind: "invalid";
|
|
7103
|
+
/**
|
|
7104
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
7105
|
+
*/
|
|
7106
|
+
message: string;
|
|
7107
|
+
}
|
|
7108
|
+
/**
|
|
7109
|
+
* The selection group was already terminated or its pending host hand-off was already claimed.
|
|
7110
|
+
*
|
|
7111
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7112
|
+
* via the `definition` "CatalogSelectionReplayed".
|
|
7113
|
+
*/
|
|
7114
|
+
/** @experimental */
|
|
7115
|
+
export interface CatalogSelectionReplayed {
|
|
7116
|
+
/**
|
|
7117
|
+
* Discriminator for this typed selection rejection
|
|
7118
|
+
*/
|
|
7119
|
+
kind: "replayed";
|
|
7120
|
+
/**
|
|
7121
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
7122
|
+
*/
|
|
7123
|
+
message: string;
|
|
7124
|
+
}
|
|
7125
|
+
/**
|
|
7126
|
+
* Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.
|
|
7127
|
+
*
|
|
7128
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7129
|
+
* via the `definition` "CatalogSelectionRequest".
|
|
7130
|
+
*/
|
|
7131
|
+
/** @experimental */
|
|
7132
|
+
export interface CatalogSelectionRequest {
|
|
7133
|
+
contract: CatalogClientContract;
|
|
7134
|
+
/**
|
|
7135
|
+
* Locally owned root session whose retained search state is being resolved.
|
|
7136
|
+
*/
|
|
7137
|
+
sessionId: string;
|
|
7138
|
+
/**
|
|
7139
|
+
* Opaque runtime-instance scoped reference to one visible candidate. For a non-selected outcome, any candidate reference from the same search closes that search's retained group.
|
|
7140
|
+
*/
|
|
7141
|
+
selectionRef: string;
|
|
7142
|
+
outcome: CatalogSelectionDecision;
|
|
7143
|
+
}
|
|
7144
|
+
/**
|
|
7145
|
+
* The chosen candidate was transferred into a fresh bounded single-use handle for a later explicit planning request.
|
|
7146
|
+
*
|
|
7147
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7148
|
+
* via the `definition` "CatalogSelectionSelected".
|
|
7149
|
+
*/
|
|
7150
|
+
/** @experimental */
|
|
7151
|
+
export interface CatalogSelectionSelected {
|
|
7152
|
+
/**
|
|
7153
|
+
* Discriminator: one candidate was selected
|
|
7154
|
+
*/
|
|
7155
|
+
kind: "selected";
|
|
7156
|
+
/**
|
|
7157
|
+
* Fresh single-use candidate handle accepted by mcp.planInstall. Returned only to the native host and never included in model-tool output.
|
|
7158
|
+
*/
|
|
7159
|
+
candidateHandle: string;
|
|
7160
|
+
/**
|
|
7161
|
+
* The exact search identifier privately bound to the selected candidate.
|
|
7162
|
+
*/
|
|
7163
|
+
searchId: string;
|
|
7164
|
+
}
|
|
7165
|
+
/**
|
|
7166
|
+
* The host declared that its live selection interaction timed out, and the retained search state was released.
|
|
7167
|
+
*
|
|
7168
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7169
|
+
* via the `definition` "CatalogSelectionTimedOut".
|
|
7170
|
+
*/
|
|
7171
|
+
/** @experimental */
|
|
7172
|
+
export interface CatalogSelectionTimedOut {
|
|
7173
|
+
/**
|
|
7174
|
+
* Discriminator: the host's live interaction timed out
|
|
7175
|
+
*/
|
|
7176
|
+
kind: "timed-out";
|
|
7177
|
+
/**
|
|
7178
|
+
* The search identifier privately bound to the released selection group.
|
|
7179
|
+
*/
|
|
7180
|
+
searchId: string;
|
|
7181
|
+
}
|
|
7182
|
+
/**
|
|
7183
|
+
* The runtime-enforced selection reference lifetime elapsed before the request arrived.
|
|
7184
|
+
*
|
|
7185
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7186
|
+
* via the `definition` "CatalogSelectionStale".
|
|
7187
|
+
*/
|
|
7188
|
+
/** @experimental */
|
|
7189
|
+
export interface CatalogSelectionStale {
|
|
7190
|
+
/**
|
|
7191
|
+
* Discriminator for this typed selection rejection
|
|
7192
|
+
*/
|
|
7193
|
+
kind: "stale";
|
|
7194
|
+
/**
|
|
7195
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
7196
|
+
*/
|
|
7197
|
+
message: string;
|
|
7198
|
+
}
|
|
7199
|
+
/**
|
|
7200
|
+
* The presented opaque handle was issued for another catalog operation.
|
|
7201
|
+
*
|
|
7202
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7203
|
+
* via the `definition` "CatalogSelectionWrongKind".
|
|
7204
|
+
*/
|
|
7205
|
+
/** @experimental */
|
|
7206
|
+
export interface CatalogSelectionWrongKind {
|
|
7207
|
+
/**
|
|
7208
|
+
* Discriminator for this typed selection rejection
|
|
7209
|
+
*/
|
|
7210
|
+
kind: "wrong-kind";
|
|
7211
|
+
/**
|
|
7212
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
7213
|
+
*/
|
|
7214
|
+
message: string;
|
|
7215
|
+
}
|
|
6373
7216
|
/**
|
|
6374
7217
|
* No transport this runtime can use is available for the requested server.
|
|
6375
7218
|
*
|
|
@@ -6805,50 +7648,277 @@ export interface ConnectedRemoteSessionMetadataRepository {
|
|
|
6805
7648
|
branch: string;
|
|
6806
7649
|
}
|
|
6807
7650
|
/**
|
|
6808
|
-
*
|
|
7651
|
+
* Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
|
|
6809
7652
|
*
|
|
6810
7653
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6811
|
-
* via the `definition` "
|
|
7654
|
+
* via the `definition` "ConnectorAccountRequest".
|
|
6812
7655
|
*/
|
|
6813
7656
|
/** @experimental */
|
|
6814
|
-
export interface
|
|
7657
|
+
export interface ConnectorAccountRequest {
|
|
6815
7658
|
/**
|
|
6816
|
-
*
|
|
7659
|
+
* Opaque account selection ID previously returned by an account discovery API.
|
|
6817
7660
|
*/
|
|
6818
|
-
|
|
7661
|
+
accountId: string;
|
|
6819
7662
|
}
|
|
6820
7663
|
/**
|
|
6821
|
-
*
|
|
7664
|
+
* Account-targeted authorization update required by the Connector service. The account ID is an opaque host routing identifier; no credential is included.
|
|
6822
7665
|
*
|
|
6823
7666
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6824
|
-
* via the `definition` "
|
|
7667
|
+
* via the `definition` "ConnectorAuthorizationRequirement".
|
|
6825
7668
|
*/
|
|
6826
7669
|
/** @experimental */
|
|
6827
|
-
export interface
|
|
7670
|
+
export interface ConnectorAuthorizationRequirement {
|
|
6828
7671
|
/**
|
|
6829
|
-
*
|
|
7672
|
+
* Exact opaque account selection that made the Connector request.
|
|
6830
7673
|
*/
|
|
6831
|
-
|
|
7674
|
+
accountId: string;
|
|
7675
|
+
scope: ConnectorAuthorizationScope;
|
|
6832
7676
|
}
|
|
6833
7677
|
/**
|
|
6834
|
-
*
|
|
7678
|
+
* Feature detection and hard polling limits for the EXPERIMENTAL session connector API.
|
|
6835
7679
|
*
|
|
6836
7680
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6837
|
-
* via the `definition` "
|
|
7681
|
+
* via the `definition` "ConnectorCapabilities".
|
|
6838
7682
|
*/
|
|
6839
7683
|
/** @experimental */
|
|
6840
|
-
export interface
|
|
7684
|
+
export interface ConnectorCapabilities {
|
|
6841
7685
|
/**
|
|
6842
|
-
*
|
|
7686
|
+
* Connector API contract version.
|
|
6843
7687
|
*/
|
|
6844
|
-
|
|
7688
|
+
apiVersion: number;
|
|
7689
|
+
availability: ConnectorAvailability;
|
|
6845
7690
|
/**
|
|
6846
|
-
*
|
|
7691
|
+
* Whether connect and reconnect can return an opaque continuation for bounded consent polling.
|
|
6847
7692
|
*/
|
|
6848
|
-
|
|
7693
|
+
consentContinuation: boolean;
|
|
7694
|
+
/**
|
|
7695
|
+
* Whether callers select a host-owned GitHub account through an opaque selection ID rather than supplying a provider token.
|
|
7696
|
+
*/
|
|
7697
|
+
opaqueAccountSelection: boolean;
|
|
7698
|
+
/**
|
|
7699
|
+
* Maximum accepted polling attempts for one continuation call.
|
|
7700
|
+
*/
|
|
7701
|
+
maxPollAttempts: number;
|
|
7702
|
+
/**
|
|
7703
|
+
* Maximum accepted delay in milliseconds between polling attempts.
|
|
7704
|
+
*/
|
|
7705
|
+
maxPollIntervalMs: number;
|
|
7706
|
+
/**
|
|
7707
|
+
* Maximum accepted wall-clock deadline in milliseconds for one continuation call.
|
|
7708
|
+
*/
|
|
7709
|
+
maxDeadlineMs: number;
|
|
6849
7710
|
}
|
|
6850
7711
|
/**
|
|
6851
|
-
*
|
|
7712
|
+
* Credential-free Connector catalog entry.
|
|
7713
|
+
*
|
|
7714
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7715
|
+
* via the `definition` "ConnectorCatalogEntry".
|
|
7716
|
+
*/
|
|
7717
|
+
/** @experimental */
|
|
7718
|
+
export interface ConnectorCatalogEntry {
|
|
7719
|
+
/**
|
|
7720
|
+
* Canonical Connector name used by lifecycle methods.
|
|
7721
|
+
*/
|
|
7722
|
+
name: string;
|
|
7723
|
+
/**
|
|
7724
|
+
* Untrusted display label from the service.
|
|
7725
|
+
*/
|
|
7726
|
+
displayName: string;
|
|
7727
|
+
/**
|
|
7728
|
+
* Untrusted service description, when present.
|
|
7729
|
+
*/
|
|
7730
|
+
description?: string;
|
|
7731
|
+
status: ConnectorCatalogStatus;
|
|
7732
|
+
/**
|
|
7733
|
+
* Opaque stable runtime IDs currently projected into the session for this Connector.
|
|
7734
|
+
*/
|
|
7735
|
+
runtimeServerIds: string[];
|
|
7736
|
+
}
|
|
7737
|
+
/**
|
|
7738
|
+
* Validated Connector catalog snapshot cached by the session.
|
|
7739
|
+
*
|
|
7740
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7741
|
+
* via the `definition` "ConnectorCatalogResult".
|
|
7742
|
+
*/
|
|
7743
|
+
/** @experimental */
|
|
7744
|
+
export interface ConnectorCatalogResult {
|
|
7745
|
+
/**
|
|
7746
|
+
* Monotonically increasing session-local catalog revision.
|
|
7747
|
+
*/
|
|
7748
|
+
revision: number;
|
|
7749
|
+
/**
|
|
7750
|
+
* Unix epoch milliseconds when this snapshot was accepted.
|
|
7751
|
+
*/
|
|
7752
|
+
refreshedAtMs: number;
|
|
7753
|
+
/**
|
|
7754
|
+
* Validated catalog entries in service order.
|
|
7755
|
+
*/
|
|
7756
|
+
connectors: ConnectorCatalogEntry[];
|
|
7757
|
+
}
|
|
7758
|
+
/**
|
|
7759
|
+
* Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
|
|
7760
|
+
*
|
|
7761
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7762
|
+
* via the `definition` "ConnectorConnectRequest".
|
|
7763
|
+
*/
|
|
7764
|
+
/** @experimental */
|
|
7765
|
+
export interface ConnectorConnectRequest {
|
|
7766
|
+
/**
|
|
7767
|
+
* Opaque account selection ID. It must match the account already pinned to the session, if any.
|
|
7768
|
+
*/
|
|
7769
|
+
accountId: string;
|
|
7770
|
+
/**
|
|
7771
|
+
* Canonical Connector name from the current catalog.
|
|
7772
|
+
*/
|
|
7773
|
+
connectorName: string;
|
|
7774
|
+
}
|
|
7775
|
+
/**
|
|
7776
|
+
* Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
|
|
7777
|
+
*
|
|
7778
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7779
|
+
* via the `definition` "ConnectorStatus".
|
|
7780
|
+
*/
|
|
7781
|
+
/** @experimental */
|
|
7782
|
+
export interface ConnectorStatus {
|
|
7783
|
+
/**
|
|
7784
|
+
* Connector API contract version.
|
|
7785
|
+
*/
|
|
7786
|
+
apiVersion: number;
|
|
7787
|
+
availability: ConnectorAvailability;
|
|
7788
|
+
/**
|
|
7789
|
+
* Opaque account selection pinned to this session, when one has been selected.
|
|
7790
|
+
*/
|
|
7791
|
+
accountId?: string;
|
|
7792
|
+
catalog?: ConnectorCatalogResult;
|
|
7793
|
+
authorizationRequirement?: ConnectorAuthorizationRequirement;
|
|
7794
|
+
/**
|
|
7795
|
+
* Live MCP status for every Connector-owned runtime server.
|
|
7796
|
+
*/
|
|
7797
|
+
runtimeServers: ConnectorRuntimeStatus[];
|
|
7798
|
+
/**
|
|
7799
|
+
* Number of active opaque connection continuations.
|
|
7800
|
+
*/
|
|
7801
|
+
pendingConnections: number;
|
|
7802
|
+
}
|
|
7803
|
+
/**
|
|
7804
|
+
* Live status of one session-owned MCP projection.
|
|
7805
|
+
*
|
|
7806
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7807
|
+
* via the `definition` "ConnectorRuntimeStatus".
|
|
7808
|
+
*/
|
|
7809
|
+
/** @experimental */
|
|
7810
|
+
export interface ConnectorRuntimeStatus {
|
|
7811
|
+
/**
|
|
7812
|
+
* Opaque runtime server ID.
|
|
7813
|
+
*/
|
|
7814
|
+
runtimeServerId: string;
|
|
7815
|
+
/**
|
|
7816
|
+
* Canonical Connector name that owns this server.
|
|
7817
|
+
*/
|
|
7818
|
+
connectorName: string;
|
|
7819
|
+
status: ConnectorMcpStatus;
|
|
7820
|
+
}
|
|
7821
|
+
/**
|
|
7822
|
+
* Explicitly bounded continuation of a pending Connector connection.
|
|
7823
|
+
*
|
|
7824
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7825
|
+
* via the `definition` "ConnectorContinueRequest".
|
|
7826
|
+
*/
|
|
7827
|
+
/** @experimental */
|
|
7828
|
+
export interface ConnectorContinueRequest {
|
|
7829
|
+
/**
|
|
7830
|
+
* Opaque continuation ID returned by connect, reconnect, or an earlier continuation.
|
|
7831
|
+
*/
|
|
7832
|
+
continuationId: string;
|
|
7833
|
+
/**
|
|
7834
|
+
* Maximum catalog requests made by this call. Must be between one and the capability limit.
|
|
7835
|
+
*/
|
|
7836
|
+
maxAttempts: number;
|
|
7837
|
+
/**
|
|
7838
|
+
* Delay in milliseconds between attempts. Must not exceed the capability limit.
|
|
7839
|
+
*/
|
|
7840
|
+
pollIntervalMs: number;
|
|
7841
|
+
/**
|
|
7842
|
+
* Maximum wall-clock duration in milliseconds for this call. Must be between one and the capability limit.
|
|
7843
|
+
*/
|
|
7844
|
+
deadlineMs: number;
|
|
7845
|
+
}
|
|
7846
|
+
/**
|
|
7847
|
+
* Authoritative result after disconnect and MCP reconciliation.
|
|
7848
|
+
*
|
|
7849
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7850
|
+
* via the `definition` "ConnectorDisconnectResult".
|
|
7851
|
+
*/
|
|
7852
|
+
/** @experimental */
|
|
7853
|
+
export interface ConnectorDisconnectResult {
|
|
7854
|
+
/**
|
|
7855
|
+
* Whether the service accepted the idempotent disconnect.
|
|
7856
|
+
*/
|
|
7857
|
+
disconnected: boolean;
|
|
7858
|
+
status: ConnectorStatus;
|
|
7859
|
+
}
|
|
7860
|
+
/**
|
|
7861
|
+
* Requests authoritative Connector-to-MCP reconciliation for the pinned account.
|
|
7862
|
+
*
|
|
7863
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7864
|
+
* via the `definition` "ConnectorReconcileRequest".
|
|
7865
|
+
*/
|
|
7866
|
+
/** @experimental */
|
|
7867
|
+
export interface ConnectorReconcileRequest {
|
|
7868
|
+
/**
|
|
7869
|
+
* Opaque account selection ID. It must match the account already pinned to the session, if any.
|
|
7870
|
+
*/
|
|
7871
|
+
accountId: string;
|
|
7872
|
+
/**
|
|
7873
|
+
* When true, refresh the catalog before reconciling. A disabled Connector API performs no service request.
|
|
7874
|
+
*/
|
|
7875
|
+
refreshCatalog?: boolean;
|
|
7876
|
+
}
|
|
7877
|
+
/**
|
|
7878
|
+
* Remote session connection parameters.
|
|
7879
|
+
*
|
|
7880
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7881
|
+
* via the `definition` "ConnectRemoteSessionParams".
|
|
7882
|
+
*/
|
|
7883
|
+
/** @experimental */
|
|
7884
|
+
export interface ConnectRemoteSessionParams {
|
|
7885
|
+
/**
|
|
7886
|
+
* Session ID to connect to.
|
|
7887
|
+
*/
|
|
7888
|
+
sessionId: string;
|
|
7889
|
+
}
|
|
7890
|
+
/**
|
|
7891
|
+
* Local file system absolute paths within the session working directory to check against its content-exclusion policy.
|
|
7892
|
+
*
|
|
7893
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7894
|
+
* via the `definition` "ContentExclusionCheckPathsRequest".
|
|
7895
|
+
*/
|
|
7896
|
+
/** @experimental */
|
|
7897
|
+
export interface ContentExclusionCheckPathsRequest {
|
|
7898
|
+
/**
|
|
7899
|
+
* Local file system absolute paths within the session working directory to check. Results are returned in the same order, including duplicates.
|
|
7900
|
+
*/
|
|
7901
|
+
paths: string[];
|
|
7902
|
+
}
|
|
7903
|
+
/**
|
|
7904
|
+
* Batch content-exclusion result. Callers must fail closed when policy evaluation is unavailable.
|
|
7905
|
+
*
|
|
7906
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7907
|
+
* via the `definition` "ContentExclusionCheckPathsResult".
|
|
7908
|
+
*/
|
|
7909
|
+
/** @experimental */
|
|
7910
|
+
export interface ContentExclusionCheckPathsResult {
|
|
7911
|
+
/**
|
|
7912
|
+
* Whether the session's policy service was available for the complete batch. When false, checks is empty and callers must treat every requested path as excluded.
|
|
7913
|
+
*/
|
|
7914
|
+
available: boolean;
|
|
7915
|
+
/**
|
|
7916
|
+
* Per-path decisions in request order. Empty when available is false.
|
|
7917
|
+
*/
|
|
7918
|
+
checks: ContentExclusionPathCheck[];
|
|
7919
|
+
}
|
|
7920
|
+
/**
|
|
7921
|
+
* Content-exclusion decision for one requested path.
|
|
6852
7922
|
*
|
|
6853
7923
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6854
7924
|
* via the `definition` "ContentExclusionPathCheck".
|
|
@@ -6956,7 +8026,7 @@ export interface CurrentToolMetadata {
|
|
|
6956
8026
|
deferLoading?: boolean;
|
|
6957
8027
|
}
|
|
6958
8028
|
/**
|
|
6959
|
-
* A file included in the
|
|
8029
|
+
* A file included in the session debug bundle.
|
|
6960
8030
|
*
|
|
6961
8031
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6962
8032
|
* via the `definition` "DebugCollectLogsCollectedEntry".
|
|
@@ -7034,7 +8104,7 @@ export interface DebugCollectLogsInclude {
|
|
|
7034
8104
|
previousProcessLogLimit?: number;
|
|
7035
8105
|
}
|
|
7036
8106
|
/**
|
|
7037
|
-
* Options for collecting a
|
|
8107
|
+
* Options for collecting a session debug bundle with configurable redaction.
|
|
7038
8108
|
*
|
|
7039
8109
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7040
8110
|
* via the `definition` "DebugCollectLogsRequest".
|
|
@@ -7049,7 +8119,7 @@ export interface DebugCollectLogsRequest {
|
|
|
7049
8119
|
additionalEntries?: DebugCollectLogsEntry[];
|
|
7050
8120
|
}
|
|
7051
8121
|
/**
|
|
7052
|
-
* Result of collecting a
|
|
8122
|
+
* Result of collecting a session debug bundle.
|
|
7053
8123
|
*
|
|
7054
8124
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7055
8125
|
* via the `definition` "DebugCollectLogsResult".
|
|
@@ -7062,7 +8132,7 @@ export interface DebugCollectLogsResult {
|
|
|
7062
8132
|
*/
|
|
7063
8133
|
path: string;
|
|
7064
8134
|
/**
|
|
7065
|
-
* Files included in the
|
|
8135
|
+
* Files included in the bundle.
|
|
7066
8136
|
*/
|
|
7067
8137
|
entries: DebugCollectLogsCollectedEntry[];
|
|
7068
8138
|
/**
|
|
@@ -7308,18 +8378,16 @@ export interface EnqueueCommandParams {
|
|
|
7308
8378
|
*/
|
|
7309
8379
|
displayText?: string | null;
|
|
7310
8380
|
}
|
|
7311
|
-
/**
|
|
7312
|
-
* Indicates whether the command was accepted into the local execution queue.
|
|
7313
|
-
*
|
|
7314
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7315
|
-
* via the `definition` "EnqueueCommandResult".
|
|
7316
|
-
*/
|
|
7317
8381
|
/** @experimental */
|
|
7318
|
-
export interface
|
|
8382
|
+
export interface UnsupportedEnqueueCommandResult {
|
|
7319
8383
|
/**
|
|
7320
|
-
*
|
|
8384
|
+
* False because the target session does not support local command queueing (e.g. remote sessions).
|
|
7321
8385
|
*/
|
|
7322
|
-
queued:
|
|
8386
|
+
queued: false;
|
|
8387
|
+
/**
|
|
8388
|
+
* Legacy null queue ID accepted for compatibility with older runtimes.
|
|
8389
|
+
*/
|
|
8390
|
+
queueId?: null;
|
|
7323
8391
|
}
|
|
7324
8392
|
/**
|
|
7325
8393
|
* Cursor, batch size, and optional long-poll/filter parameters for reading session events.
|
|
@@ -9575,6 +10643,22 @@ export interface InstalledPluginInfo {
|
|
|
9575
10643
|
* Absolute path of the marketplace directory a live plugin was resolved from. Present only on live, never-persisted records — a plugin belonging to a directory/local marketplace, which is loaded from its real directory on every pass instead of a copy under the installed-plugins cache. Its presence is what marks a listed plugin as live: such a plugin is always present on disk, so `enabled` is its only meaningful state and it is never "not installed".
|
|
9576
10644
|
*/
|
|
9577
10645
|
installedFrom?: string;
|
|
10646
|
+
/**
|
|
10647
|
+
* Runtime-reported plugin provenance. Currently set to "builtin" only for plugins registered through the trusted host built-in boundary; absent for installed, marketplace, direct, and live plugins.
|
|
10648
|
+
*/
|
|
10649
|
+
source?: string;
|
|
10650
|
+
/**
|
|
10651
|
+
* Whether enterprise managed settings control this plugin's enabled state.
|
|
10652
|
+
*/
|
|
10653
|
+
managed?: boolean;
|
|
10654
|
+
/**
|
|
10655
|
+
* The enabled state required by enterprise managed settings, when this plugin spec is managed.
|
|
10656
|
+
*/
|
|
10657
|
+
managedDesiredEnabled?: boolean;
|
|
10658
|
+
/**
|
|
10659
|
+
* Whether the managed desired plugin currently has an installed or live record. Set to false for a managed desired entry retained in the listing after installation or reconciliation failed.
|
|
10660
|
+
*/
|
|
10661
|
+
installed?: boolean;
|
|
9578
10662
|
}
|
|
9579
10663
|
/**
|
|
9580
10664
|
* Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path.
|
|
@@ -9728,6 +10812,31 @@ export interface InterruptMainTurnResult {
|
|
|
9728
10812
|
*/
|
|
9729
10813
|
interrupted: boolean;
|
|
9730
10814
|
}
|
|
10815
|
+
/**
|
|
10816
|
+
* A JSON Schema output contract. OpenAI receives the name, description, schema and strict setting; Anthropic receives the schema in output_config.format and always uses its native strict enforcement.
|
|
10817
|
+
*
|
|
10818
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
10819
|
+
* via the `definition` "JsonSchemaResponseFormat".
|
|
10820
|
+
*/
|
|
10821
|
+
/** @experimental */
|
|
10822
|
+
export interface JsonSchemaResponseFormat {
|
|
10823
|
+
/**
|
|
10824
|
+
* Name of the output schema, subject to the provider's naming restrictions.
|
|
10825
|
+
*/
|
|
10826
|
+
name: string;
|
|
10827
|
+
/**
|
|
10828
|
+
* JSON Schema passed unchanged to the inference provider. Schemas larger than 32 MiB when JSON-encoded are rejected before admission, using the runtime's existing request-size ceiling. This is not a guarantee that the entire model request fits. Supported keywords and schema restrictions are determined by the provider.
|
|
10829
|
+
*/
|
|
10830
|
+
schema: JsonValue;
|
|
10831
|
+
/**
|
|
10832
|
+
* Optional description passed to OpenAI providers.
|
|
10833
|
+
*/
|
|
10834
|
+
description?: string;
|
|
10835
|
+
/**
|
|
10836
|
+
* Optional strict enforcement setting for OpenAI providers. Omitted uses the provider default. Anthropic always enforces its supported schema subset.
|
|
10837
|
+
*/
|
|
10838
|
+
strict?: boolean;
|
|
10839
|
+
}
|
|
9731
10840
|
/**
|
|
9732
10841
|
* HTTP headers as a map from lowercased header name to a list of values. Multi-valued headers (e.g. Set-Cookie) preserve all values.
|
|
9733
10842
|
*
|
|
@@ -10076,6 +11185,35 @@ export interface LspInitializeRequest {
|
|
|
10076
11185
|
*/
|
|
10077
11186
|
force?: boolean;
|
|
10078
11187
|
}
|
|
11188
|
+
/**
|
|
11189
|
+
* Non-secret host-managed HTTP MCP server configuration. The containing map key is the stable managed identity; credentials are supplied dynamically by the host.
|
|
11190
|
+
*
|
|
11191
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11192
|
+
* via the `definition` "ManagedMcpServerConfig".
|
|
11193
|
+
*/
|
|
11194
|
+
/** @experimental */
|
|
11195
|
+
export interface ManagedMcpServerConfig {
|
|
11196
|
+
/**
|
|
11197
|
+
* Human-readable catalog display name.
|
|
11198
|
+
*/
|
|
11199
|
+
displayName: string;
|
|
11200
|
+
/**
|
|
11201
|
+
* Hosted MCP streamable HTTP endpoint.
|
|
11202
|
+
*/
|
|
11203
|
+
url: string;
|
|
11204
|
+
/**
|
|
11205
|
+
* Tools to include. Defaults to all tools when omitted.
|
|
11206
|
+
*/
|
|
11207
|
+
tools?: string[];
|
|
11208
|
+
/**
|
|
11209
|
+
* Timeout in milliseconds for tool discovery and tool calls.
|
|
11210
|
+
*/
|
|
11211
|
+
timeout?: number;
|
|
11212
|
+
/**
|
|
11213
|
+
* Maximum dynamic-header cache lifetime in milliseconds.
|
|
11214
|
+
*/
|
|
11215
|
+
headersRefreshTtlMs?: number;
|
|
11216
|
+
}
|
|
10079
11217
|
/**
|
|
10080
11218
|
* Validated device-managed settings discovered before a session exists.
|
|
10081
11219
|
*
|
|
@@ -10156,6 +11294,14 @@ export interface MarketplaceInfo {
|
|
|
10156
11294
|
* True when this is a default marketplace shipped with the runtime. Defaults are not removable.
|
|
10157
11295
|
*/
|
|
10158
11296
|
isDefault?: boolean;
|
|
11297
|
+
/**
|
|
11298
|
+
* Whether enterprise managed settings provide and control this marketplace entry.
|
|
11299
|
+
*/
|
|
11300
|
+
managed?: boolean;
|
|
11301
|
+
/**
|
|
11302
|
+
* Whether the managed marketplace currently resolved into the runtime marketplace registry. Set to false when the desired managed entry is retained for governance visibility after loading or reconciliation failed.
|
|
11303
|
+
*/
|
|
11304
|
+
available?: boolean;
|
|
10159
11305
|
}
|
|
10160
11306
|
/**
|
|
10161
11307
|
* All registered marketplaces, including built-in defaults.
|
|
@@ -10572,6 +11718,10 @@ export interface McpServerConfigStdio {
|
|
|
10572
11718
|
* Timeout in milliseconds for tool discovery and tool calls.
|
|
10573
11719
|
*/
|
|
10574
11720
|
timeout?: number;
|
|
11721
|
+
/**
|
|
11722
|
+
* Milliseconds this server may spend connecting before the CLI warns that it is taking longer than expected. Presentation only: it does not change how long the connection is allowed to take.
|
|
11723
|
+
*/
|
|
11724
|
+
slowConnectionThresholdMs?: number;
|
|
10575
11725
|
oidc?: McpServerAuthConfig;
|
|
10576
11726
|
auth?: McpServerAuthConfig;
|
|
10577
11727
|
deferTools?: McpServerConfigDeferTools;
|
|
@@ -10693,6 +11843,10 @@ export interface McpServerConfigHttp {
|
|
|
10693
11843
|
* Timeout in milliseconds for tool discovery and tool calls.
|
|
10694
11844
|
*/
|
|
10695
11845
|
timeout?: number;
|
|
11846
|
+
/**
|
|
11847
|
+
* Milliseconds this server may spend connecting before the CLI warns that it is taking longer than expected. Presentation only: it does not change how long the connection is allowed to take.
|
|
11848
|
+
*/
|
|
11849
|
+
slowConnectionThresholdMs?: number;
|
|
10696
11850
|
oidc?: McpServerAuthConfig;
|
|
10697
11851
|
auth?: McpServerAuthConfig;
|
|
10698
11852
|
deferTools?: McpServerConfigDeferTools;
|
|
@@ -11117,7 +12271,7 @@ export interface McpInstallPlan {
|
|
|
11117
12271
|
target: McpPlanTarget;
|
|
11118
12272
|
policy: McpPlanPolicyResult;
|
|
11119
12273
|
/**
|
|
11120
|
-
*
|
|
12274
|
+
* Alternative configuration changes, with exactly one entry for each transportChoices entry in the same order. Only the entry for the subsequently selected transport applies; these are not cumulative writes. Payloads remain behind the runtime boundary.
|
|
11121
12275
|
*/
|
|
11122
12276
|
configurationChanges: McpPlanConfigurationChange[];
|
|
11123
12277
|
/**
|
|
@@ -11125,7 +12279,7 @@ export interface McpInstallPlan {
|
|
|
11125
12279
|
*/
|
|
11126
12280
|
reloadRequired: boolean;
|
|
11127
12281
|
/**
|
|
11128
|
-
*
|
|
12282
|
+
* True only when every eligible transport choice needs additional values or secrets. False means at least one choice needs no additional configuration, not that every choice is ready. A later apply operation must validate the selected choice's own inputs, secrets and policy after explicit confirmation.
|
|
11129
12283
|
*/
|
|
11130
12284
|
requiresInteractiveConfiguration: boolean;
|
|
11131
12285
|
}
|
|
@@ -11357,7 +12511,7 @@ export interface McpPlanPolicyResult {
|
|
|
11357
12511
|
reason?: string;
|
|
11358
12512
|
}
|
|
11359
12513
|
/**
|
|
11360
|
-
*
|
|
12514
|
+
* The configuration-change alternative for the transportChoices entry at the same index. Only the selected alternative is applied; entries are not cumulative. The payload stays behind the runtime boundary.
|
|
11361
12515
|
*
|
|
11362
12516
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11363
12517
|
* via the `definition` "McpPlanConfigurationChange".
|
|
@@ -11641,7 +12795,7 @@ export interface McpPlanInstallSourceCandidate {
|
|
|
11641
12795
|
*/
|
|
11642
12796
|
candidateHandle: string;
|
|
11643
12797
|
/**
|
|
11644
|
-
* The runtime- or authority-minted `searchId` returned with the search that produced this candidate.
|
|
12798
|
+
* The runtime- or authority-minted `searchId` returned with the search that produced this candidate. Planning verifies the private correlation and atomically consumes a matching candidate before downstream work, including attempts that subsequently fail or report unavailable. A mismatched search does not consume the candidate. It identifies a search rather than a person and must never be joined with user identity to re-identify anyone.
|
|
11645
12799
|
*/
|
|
11646
12800
|
searchId: string;
|
|
11647
12801
|
}
|
|
@@ -12033,6 +13187,10 @@ export interface McpServer {
|
|
|
12033
13187
|
* Plugin version that provided this server, when source is plugin.
|
|
12034
13188
|
*/
|
|
12035
13189
|
sourcePluginVersion?: string;
|
|
13190
|
+
/**
|
|
13191
|
+
* Human-readable display name supplied by a managed server catalog.
|
|
13192
|
+
*/
|
|
13193
|
+
displayName?: string;
|
|
12036
13194
|
/**
|
|
12037
13195
|
* Error message if the server failed to connect
|
|
12038
13196
|
*/
|
|
@@ -12491,6 +13649,10 @@ export interface ModelCapabilitiesSupports {
|
|
|
12491
13649
|
* Whether this model supports vision/image input
|
|
12492
13650
|
*/
|
|
12493
13651
|
vision?: boolean;
|
|
13652
|
+
/**
|
|
13653
|
+
* Whether this model supports canonical tool calling
|
|
13654
|
+
*/
|
|
13655
|
+
toolCalls?: boolean;
|
|
12494
13656
|
/**
|
|
12495
13657
|
* Whether this model supports reasoning effort configuration
|
|
12496
13658
|
*/
|
|
@@ -12743,6 +13905,7 @@ export interface ModelApplyStartupOverlayRequest {
|
|
|
12743
13905
|
* Startup default model from the enterprise policy helper, when configured. Weakest of the managed sources: it applies only when neither device nor server policy names a model, and an explicit user selection still wins.
|
|
12744
13906
|
*/
|
|
12745
13907
|
policyHelperModel?: string;
|
|
13908
|
+
autoTier?: AutoTier;
|
|
12746
13909
|
/**
|
|
12747
13910
|
* Model selected by repository settings, when configured.
|
|
12748
13911
|
*/
|
|
@@ -12791,6 +13954,10 @@ export interface ModelCapabilitiesOverrideSupports {
|
|
|
12791
13954
|
* Whether this model supports vision/image input
|
|
12792
13955
|
*/
|
|
12793
13956
|
vision?: boolean;
|
|
13957
|
+
/**
|
|
13958
|
+
* Whether this model supports canonical tool calling
|
|
13959
|
+
*/
|
|
13960
|
+
toolCalls?: boolean;
|
|
12794
13961
|
/**
|
|
12795
13962
|
* Whether this model supports reasoning effort configuration
|
|
12796
13963
|
*/
|
|
@@ -13030,9 +14197,9 @@ export interface ModelSwitchToRequest {
|
|
|
13030
14197
|
*/
|
|
13031
14198
|
autoTier?: AutoTier | null;
|
|
13032
14199
|
/**
|
|
13033
|
-
* Reasoning effort level to use for the model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. "none" disables reasoning. When omitted,
|
|
14200
|
+
* Reasoning effort level to use for the model. CAPI values are model-defined and validated against the selected model; BYOK providers may define additional values. "none" disables reasoning. Pass null to clear any session effort override and fall back to the model's default. When omitted, the session's current effort is kept.
|
|
13034
14201
|
*/
|
|
13035
|
-
reasoningEffort?: string;
|
|
14202
|
+
reasoningEffort?: string | null;
|
|
13036
14203
|
reasoningSummary?: ReasoningSummary;
|
|
13037
14204
|
verbosity?: Verbosity;
|
|
13038
14205
|
modelCapabilities?: ModelCapabilitiesOverride;
|
|
@@ -13072,6 +14239,10 @@ export interface ModelSwitchToRequest {
|
|
|
13072
14239
|
*/
|
|
13073
14240
|
/** @experimental */
|
|
13074
14241
|
export interface ModelSwitchToResult {
|
|
14242
|
+
/**
|
|
14243
|
+
* Stable queue item identifier when this request was enqueued. Remains present if the item drains before the response is returned.
|
|
14244
|
+
*/
|
|
14245
|
+
queueId?: string;
|
|
13075
14246
|
/**
|
|
13076
14247
|
* Currently active model identifier after the switch
|
|
13077
14248
|
*/
|
|
@@ -13380,6 +14551,10 @@ export interface PendingPermissionRequest {
|
|
|
13380
14551
|
*/
|
|
13381
14552
|
requestId: string;
|
|
13382
14553
|
request: PermissionPromptRequest;
|
|
14554
|
+
/**
|
|
14555
|
+
* Permission-recovery episode that authorized this request to surface for interactive attention
|
|
14556
|
+
*/
|
|
14557
|
+
recoveryEpisodeId?: string;
|
|
13383
14558
|
}
|
|
13384
14559
|
/**
|
|
13385
14560
|
* List of pending permission requests reconstructed from event history.
|
|
@@ -14381,7 +15556,7 @@ export interface PermissionPathsConfig {
|
|
|
14381
15556
|
workspacePath?: string;
|
|
14382
15557
|
}
|
|
14383
15558
|
/**
|
|
14384
|
-
* Snapshot of the session's
|
|
15559
|
+
* Snapshot of the session's recursive directory grants, exact session-approved paths, and primary working directory.
|
|
14385
15560
|
*
|
|
14386
15561
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14387
15562
|
* via the `definition` "PermissionPathsList".
|
|
@@ -14392,6 +15567,10 @@ export interface PermissionPathsList {
|
|
|
14392
15567
|
* All directories currently allowed for tool access on this session.
|
|
14393
15568
|
*/
|
|
14394
15569
|
directories: string[];
|
|
15570
|
+
/**
|
|
15571
|
+
* Exact paths approved for this session without recursively allowing their descendants.
|
|
15572
|
+
*/
|
|
15573
|
+
sessionApprovedPaths?: string[];
|
|
14395
15574
|
/**
|
|
14396
15575
|
* The primary working directory for this session.
|
|
14397
15576
|
*/
|
|
@@ -14697,7 +15876,7 @@ export interface PermissionsPathsAddResult {
|
|
|
14697
15876
|
success: boolean;
|
|
14698
15877
|
}
|
|
14699
15878
|
/**
|
|
14700
|
-
* No parameters; returns the session's
|
|
15879
|
+
* No parameters; returns the session's recursive directory grants and exact session-approved paths.
|
|
14701
15880
|
*
|
|
14702
15881
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14703
15882
|
* via the `definition` "PermissionsPathsListRequest".
|
|
@@ -14728,7 +15907,7 @@ export interface PermissionsPathsUpdatePrimaryResult {
|
|
|
14728
15907
|
export interface PermissionsPendingRequestsRequest {
|
|
14729
15908
|
}
|
|
14730
15909
|
/**
|
|
14731
|
-
* Clears session-scoped tool
|
|
15910
|
+
* Clears session-scoped tool approvals and optionally clears location-scoped approvals and exact session-approved paths.
|
|
14732
15911
|
*
|
|
14733
15912
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14734
15913
|
* via the `definition` "PermissionsResetSessionApprovalsRequest".
|
|
@@ -14736,7 +15915,7 @@ export interface PermissionsPendingRequestsRequest {
|
|
|
14736
15915
|
/** @experimental */
|
|
14737
15916
|
export interface PermissionsResetSessionApprovalsRequest {
|
|
14738
15917
|
/**
|
|
14739
|
-
* Whether location-scoped approvals are cleared too. Defaults to `true`.
|
|
15918
|
+
* Whether location-scoped approvals and exact session-approved paths are cleared too. Defaults to `true`.
|
|
14740
15919
|
*/
|
|
14741
15920
|
includeLocation?: boolean;
|
|
14742
15921
|
}
|
|
@@ -15029,6 +16208,30 @@ export interface Plugin {
|
|
|
15029
16208
|
* Whether the plugin is currently enabled
|
|
15030
16209
|
*/
|
|
15031
16210
|
enabled: boolean;
|
|
16211
|
+
/**
|
|
16212
|
+
* Opaque stable identity for a direct plugin source.
|
|
16213
|
+
*/
|
|
16214
|
+
directSourceId?: string;
|
|
16215
|
+
/**
|
|
16216
|
+
* Absolute marketplace directory for a live plugin.
|
|
16217
|
+
*/
|
|
16218
|
+
installedFrom?: string;
|
|
16219
|
+
/**
|
|
16220
|
+
* Runtime plugin provenance, such as "builtin".
|
|
16221
|
+
*/
|
|
16222
|
+
source?: string;
|
|
16223
|
+
/**
|
|
16224
|
+
* Whether enterprise managed settings control this plugin.
|
|
16225
|
+
*/
|
|
16226
|
+
managed?: boolean;
|
|
16227
|
+
/**
|
|
16228
|
+
* Enabled state required by enterprise managed settings.
|
|
16229
|
+
*/
|
|
16230
|
+
managedDesiredEnabled?: boolean;
|
|
16231
|
+
/**
|
|
16232
|
+
* Whether this managed desired plugin has an installed or live record.
|
|
16233
|
+
*/
|
|
16234
|
+
installed?: boolean;
|
|
15032
16235
|
}
|
|
15033
16236
|
/**
|
|
15034
16237
|
* Result of installing a plugin.
|
|
@@ -15346,35 +16549,92 @@ export interface ProtocolExternalToolDefinition {
|
|
|
15346
16549
|
[k: string]: JsonValue | undefined;
|
|
15347
16550
|
};
|
|
15348
16551
|
}
|
|
15349
|
-
/**
|
|
15350
|
-
* BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both.
|
|
15351
|
-
*
|
|
15352
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
15353
|
-
* via the `definition` "ProviderAddRequest".
|
|
15354
|
-
*/
|
|
15355
16552
|
/** @experimental */
|
|
15356
|
-
export interface
|
|
16553
|
+
export interface ProtocolStaticSectionOverride {
|
|
16554
|
+
action: ProtocolStaticSectionAction;
|
|
15357
16555
|
/**
|
|
15358
|
-
*
|
|
16556
|
+
* Optional content used by replace, append, and prepend operations.
|
|
15359
16557
|
*/
|
|
15360
|
-
|
|
16558
|
+
content?: string;
|
|
16559
|
+
}
|
|
16560
|
+
/** @experimental */
|
|
16561
|
+
export interface ProtocolSystemMessageAppendConfig {
|
|
16562
|
+
mode?: ProtocolAppendMode;
|
|
15361
16563
|
/**
|
|
15362
|
-
*
|
|
16564
|
+
* Text appended to the standard system prompt.
|
|
15363
16565
|
*/
|
|
15364
|
-
|
|
16566
|
+
content?: string;
|
|
15365
16567
|
}
|
|
15366
|
-
/**
|
|
15367
|
-
* A BYOK model definition referencing a named provider.
|
|
15368
|
-
*
|
|
15369
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
15370
|
-
* via the `definition` "ProviderModelConfig".
|
|
15371
|
-
*/
|
|
15372
16568
|
/** @experimental */
|
|
15373
|
-
export interface
|
|
16569
|
+
export interface ProtocolSystemMessageReplaceConfig {
|
|
16570
|
+
mode: ProtocolReplaceMode;
|
|
15374
16571
|
/**
|
|
15375
|
-
*
|
|
16572
|
+
* Complete replacement system-message text.
|
|
15376
16573
|
*/
|
|
15377
|
-
|
|
16574
|
+
content: string;
|
|
16575
|
+
/**
|
|
16576
|
+
* Optional structured blocks corresponding to the replacement content.
|
|
16577
|
+
*/
|
|
16578
|
+
contentBlocks?: SystemMessageBlock[];
|
|
16579
|
+
}
|
|
16580
|
+
/** @experimental */
|
|
16581
|
+
export interface SystemMessageBlock {
|
|
16582
|
+
/**
|
|
16583
|
+
* Text content for this system-message block.
|
|
16584
|
+
*/
|
|
16585
|
+
content: string;
|
|
16586
|
+
/**
|
|
16587
|
+
* Whether the block is static and may be cached independently of dynamic prompt content.
|
|
16588
|
+
*/
|
|
16589
|
+
isStatic?: boolean;
|
|
16590
|
+
/**
|
|
16591
|
+
* Whether providers with explicit prompt caching should place a cache breakpoint after this block.
|
|
16592
|
+
*/
|
|
16593
|
+
cacheBreakpoint?: boolean;
|
|
16594
|
+
}
|
|
16595
|
+
/** @experimental */
|
|
16596
|
+
export interface ProtocolSystemMessageCustomizeConfig {
|
|
16597
|
+
mode: ProtocolCustomizeMode;
|
|
16598
|
+
/**
|
|
16599
|
+
* Named standard-prompt section overrides.
|
|
16600
|
+
*/
|
|
16601
|
+
sections?: {
|
|
16602
|
+
[k: string]: ProtocolSectionOverride;
|
|
16603
|
+
};
|
|
16604
|
+
/**
|
|
16605
|
+
* Text appended after the customized sections.
|
|
16606
|
+
*/
|
|
16607
|
+
content?: string;
|
|
16608
|
+
}
|
|
16609
|
+
/**
|
|
16610
|
+
* BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both.
|
|
16611
|
+
*
|
|
16612
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
16613
|
+
* via the `definition` "ProviderAddRequest".
|
|
16614
|
+
*/
|
|
16615
|
+
/** @experimental */
|
|
16616
|
+
export interface ProviderAddRequest {
|
|
16617
|
+
/**
|
|
16618
|
+
* Named BYOK provider connections to register, additive to any providers already in the registry. Each name must be unique across the registry and must not contain '/'.
|
|
16619
|
+
*/
|
|
16620
|
+
providers?: NamedProviderConfig[];
|
|
16621
|
+
/**
|
|
16622
|
+
* BYOK model definitions to register. Each must reference a provider that is already registered or included in this same call. Selection ids (`provider/id`) must be unique across the registry.
|
|
16623
|
+
*/
|
|
16624
|
+
models?: ProviderModelConfig[];
|
|
16625
|
+
}
|
|
16626
|
+
/**
|
|
16627
|
+
* A BYOK model definition referencing a named provider.
|
|
16628
|
+
*
|
|
16629
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
16630
|
+
* via the `definition` "ProviderModelConfig".
|
|
16631
|
+
*/
|
|
16632
|
+
/** @experimental */
|
|
16633
|
+
export interface ProviderModelConfig {
|
|
16634
|
+
/**
|
|
16635
|
+
* Provider-local model id, unique within its provider. The session-wide selection id (shown in the model list and passed to switchTo) is the provider-qualified `provider/id`.
|
|
16636
|
+
*/
|
|
16637
|
+
id: string;
|
|
15378
16638
|
/**
|
|
15379
16639
|
* Name of the configured provider that serves this model.
|
|
15380
16640
|
*/
|
|
@@ -15404,6 +16664,13 @@ export interface ProviderModelConfig {
|
|
|
15404
16664
|
*/
|
|
15405
16665
|
maxOutputTokens?: number;
|
|
15406
16666
|
capabilities?: ModelCapabilitiesOverride;
|
|
16667
|
+
systemMessage?: ProtocolSystemMessageConfig;
|
|
16668
|
+
/**
|
|
16669
|
+
* Provider-published model metadata, preserved verbatim as the public Model.metadata object.
|
|
16670
|
+
*/
|
|
16671
|
+
metadata?: {
|
|
16672
|
+
[k: string]: JsonValue | undefined;
|
|
16673
|
+
};
|
|
15407
16674
|
}
|
|
15408
16675
|
/**
|
|
15409
16676
|
* The selectable model entries synthesized for the models added by this call.
|
|
@@ -15530,6 +16797,44 @@ export interface ProviderSessionToken {
|
|
|
15530
16797
|
*/
|
|
15531
16798
|
expiresAt?: string;
|
|
15532
16799
|
}
|
|
16800
|
+
/**
|
|
16801
|
+
* Authoritative BYOK provider and model registry snapshot to apply atomically to the session.
|
|
16802
|
+
*
|
|
16803
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
16804
|
+
* via the `definition` "ProviderSyncRequest".
|
|
16805
|
+
*/
|
|
16806
|
+
/** @experimental */
|
|
16807
|
+
export interface ProviderSyncRequest {
|
|
16808
|
+
/**
|
|
16809
|
+
* Named BYOK provider connection snapshot. Providers absent from this list are removed.
|
|
16810
|
+
*/
|
|
16811
|
+
providers?: NamedProviderConfig[];
|
|
16812
|
+
/**
|
|
16813
|
+
* BYOK model definition snapshot. Models absent from this list are removed.
|
|
16814
|
+
*/
|
|
16815
|
+
models?: ProviderModelConfig[];
|
|
16816
|
+
}
|
|
16817
|
+
/**
|
|
16818
|
+
* The selectable model entries and selection ids synthesized for the synchronized BYOK models.
|
|
16819
|
+
*
|
|
16820
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
16821
|
+
* via the `definition` "ProviderSyncResult".
|
|
16822
|
+
*/
|
|
16823
|
+
/** @experimental */
|
|
16824
|
+
export interface ProviderSyncResult {
|
|
16825
|
+
/**
|
|
16826
|
+
* Synthesized selectable model entries for the synchronized BYOK models.
|
|
16827
|
+
*/
|
|
16828
|
+
models: JsonValue[];
|
|
16829
|
+
/**
|
|
16830
|
+
* Provider-qualified model selection ids present after synchronization.
|
|
16831
|
+
*/
|
|
16832
|
+
selectionIds: string[];
|
|
16833
|
+
/**
|
|
16834
|
+
* True when synchronization withdrew the selected host-managed model, leaving the session with no explicit selection, so ordinary model resolution picks the session default. Synchronization never promotes a surviving host model in its place: publishing a model offers it, and the choice of which model to use stays with the user.
|
|
16835
|
+
*/
|
|
16836
|
+
modelDeselected?: boolean;
|
|
16837
|
+
}
|
|
15533
16838
|
/**
|
|
15534
16839
|
* Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`. Issued by the runtime before each outbound model request; the runtime does no caching, so this is sent once per request.
|
|
15535
16840
|
*
|
|
@@ -16019,6 +17324,36 @@ export interface PushAttachmentBlob {
|
|
|
16019
17324
|
*/
|
|
16020
17325
|
displayName?: string;
|
|
16021
17326
|
}
|
|
17327
|
+
/**
|
|
17328
|
+
* Append to one pending steering message without changing its identity or delivery position.
|
|
17329
|
+
*
|
|
17330
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17331
|
+
* via the `definition` "QueueAppendSteeringRequest".
|
|
17332
|
+
*/
|
|
17333
|
+
/** @experimental */
|
|
17334
|
+
export interface QueueAppendSteeringRequest {
|
|
17335
|
+
/**
|
|
17336
|
+
* Message identity returned by send, not the queue item id. Only unclaimed user steering messages are eligible.
|
|
17337
|
+
*/
|
|
17338
|
+
messageId: string;
|
|
17339
|
+
/**
|
|
17340
|
+
* Expected current prompt, including any previous appends. The runtime applies plan-mode normalization before comparing and refuses a changed message.
|
|
17341
|
+
*/
|
|
17342
|
+
expectedPrompt: string;
|
|
17343
|
+
agentMode: SendAgentMode;
|
|
17344
|
+
/**
|
|
17345
|
+
* Text to append after a blank line.
|
|
17346
|
+
*/
|
|
17347
|
+
prompt: string;
|
|
17348
|
+
/**
|
|
17349
|
+
* Display text to append to the existing preview after a blank line.
|
|
17350
|
+
*/
|
|
17351
|
+
displayPrompt: string;
|
|
17352
|
+
/**
|
|
17353
|
+
* Attachments to add after the message's existing attachments. An empty list preserves the existing attachments.
|
|
17354
|
+
*/
|
|
17355
|
+
attachments: Attachment[];
|
|
17356
|
+
}
|
|
16022
17357
|
/**
|
|
16023
17358
|
* Inputs for starting a deferred-idle drain.
|
|
16024
17359
|
*
|
|
@@ -16397,6 +17732,10 @@ export interface QueueSetDrainPausedRequest {
|
|
|
16397
17732
|
*/
|
|
16398
17733
|
/** @experimental */
|
|
16399
17734
|
export interface QueueSnapshotResult {
|
|
17735
|
+
/**
|
|
17736
|
+
* Queue item identifier of a model switch that has been dequeued but not yet applied.
|
|
17737
|
+
*/
|
|
17738
|
+
inFlightModelChangeId?: string;
|
|
16400
17739
|
/**
|
|
16401
17740
|
* User-facing pending items in FIFO order.
|
|
16402
17741
|
*/
|
|
@@ -16448,6 +17787,23 @@ export interface QueueUpdateTextResult {
|
|
|
16448
17787
|
*/
|
|
16449
17788
|
updated: boolean;
|
|
16450
17789
|
}
|
|
17790
|
+
/**
|
|
17791
|
+
* Conditional withdrawal of a single user message, before the runtime claims it for delivery.
|
|
17792
|
+
*
|
|
17793
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17794
|
+
* via the `definition` "QueueWithdrawMessageRequest".
|
|
17795
|
+
*/
|
|
17796
|
+
/** @experimental */
|
|
17797
|
+
export interface QueueWithdrawMessageRequest {
|
|
17798
|
+
/**
|
|
17799
|
+
* Message identity returned by send, not the queue item id. Batch messages are not eligible.
|
|
17800
|
+
*/
|
|
17801
|
+
messageId: string;
|
|
17802
|
+
/**
|
|
17803
|
+
* The prompt originally sent. A message edited since submission is not withdrawn, so an obsolete draft cannot replace the edit.
|
|
17804
|
+
*/
|
|
17805
|
+
expectedPrompt: string;
|
|
17806
|
+
}
|
|
16451
17807
|
/**
|
|
16452
17808
|
* Event type to register consumer interest for, used by runtime gating logic.
|
|
16453
17809
|
*
|
|
@@ -16474,15 +17830,6 @@ export interface RegisterEventInterestResult {
|
|
|
16474
17830
|
*/
|
|
16475
17831
|
handle: string;
|
|
16476
17832
|
}
|
|
16477
|
-
/**
|
|
16478
|
-
* Optional registration options.
|
|
16479
|
-
*
|
|
16480
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
16481
|
-
* via the `definition` "SessionsRegisterExtensionToolsOnSessionOptions".
|
|
16482
|
-
*/
|
|
16483
|
-
/** @experimental */
|
|
16484
|
-
export interface SessionsRegisterExtensionToolsOnSessionOptions {
|
|
16485
|
-
}
|
|
16486
17833
|
/**
|
|
16487
17834
|
* Opaque handle previously returned by `registerInterest` to release.
|
|
16488
17835
|
*
|
|
@@ -16904,6 +18251,14 @@ export interface SandboxConfigUserPolicyFilesystem {
|
|
|
16904
18251
|
*/
|
|
16905
18252
|
/** @experimental */
|
|
16906
18253
|
export interface SandboxConfigUserPolicyNetwork {
|
|
18254
|
+
/**
|
|
18255
|
+
* Hosts allowed through the built-in sandbox proxy. A non-empty list denies unmatched hosts; an absent or empty list allows all hosts not blocked. Supports exact hostnames, IP addresses, and *.example.com for strict subdomains. Host rules do not override the outbound or local-network toggles.
|
|
18256
|
+
*/
|
|
18257
|
+
allowedHosts?: string[];
|
|
18258
|
+
/**
|
|
18259
|
+
* Hosts denied by the built-in sandbox proxy. Deny rules take precedence over allowedHosts. A domain also denies all its subdomains. IP addresses match exactly; *.example.com matches strict subdomains, and * denies every host.
|
|
18260
|
+
*/
|
|
18261
|
+
blockedHosts?: string[];
|
|
16907
18262
|
/**
|
|
16908
18263
|
* Whether outbound network traffic is allowed at all.
|
|
16909
18264
|
*/
|
|
@@ -17342,7 +18697,7 @@ export interface SendMessageItem {
|
|
|
17342
18697
|
/** @experimental */
|
|
17343
18698
|
export interface SendMessagesRequest {
|
|
17344
18699
|
/**
|
|
17345
|
-
* The user messages to append to the conversation, in order. May be empty, in which case a single turn runs over the existing history with no new user message.
|
|
18700
|
+
* The user messages to append to the conversation, in order, before running one agent loop. When the batch starts a run, its final message is the primary initiating message; earlier messages provide context, not separate runs or replies. May be empty, in which case a single turn runs over the existing history with no new user message or originatingMessageId.
|
|
17346
18701
|
*/
|
|
17347
18702
|
messages: SendMessageItem[];
|
|
17348
18703
|
mode?: SendMode;
|
|
@@ -17357,6 +18712,7 @@ export interface SendMessagesRequest {
|
|
|
17357
18712
|
requestHeaders?: {
|
|
17358
18713
|
[k: string]: string | undefined;
|
|
17359
18714
|
};
|
|
18715
|
+
responseFormat?: ResponseFormat;
|
|
17360
18716
|
/**
|
|
17361
18717
|
* W3C Trace Context traceparent header for distributed tracing of this agent turn
|
|
17362
18718
|
*/
|
|
@@ -17379,7 +18735,7 @@ export interface SendMessagesRequest {
|
|
|
17379
18735
|
/** @experimental */
|
|
17380
18736
|
export interface SendMessagesResult {
|
|
17381
18737
|
/**
|
|
17382
|
-
* Unique identifiers assigned to the messages, one per provided message in order. Empty when no messages were provided.
|
|
18738
|
+
* Unique identifiers assigned to the messages, one per provided message in order. For a batch that starts a run, assistant messages use the final ID as originatingMessageId throughout that run, including tool iterations and stop-hook corrections. Immediate steering does not replace the active run's origin. Empty when no messages were provided; that run has no originatingMessageId.
|
|
17383
18739
|
*/
|
|
17384
18740
|
messageIds: string[];
|
|
17385
18741
|
}
|
|
@@ -17423,6 +18779,7 @@ export interface SendRequest {
|
|
|
17423
18779
|
requestHeaders?: {
|
|
17424
18780
|
[k: string]: string | undefined;
|
|
17425
18781
|
};
|
|
18782
|
+
responseFormat?: ResponseFormat;
|
|
17426
18783
|
/**
|
|
17427
18784
|
* W3C Trace Context traceparent header for distributed tracing of this agent turn
|
|
17428
18785
|
*/
|
|
@@ -17940,7 +19297,7 @@ export interface SessionFsSetProviderCapabilities {
|
|
|
17940
19297
|
sqlite?: boolean;
|
|
17941
19298
|
}
|
|
17942
19299
|
/**
|
|
17943
|
-
* Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider.
|
|
19300
|
+
* Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. A registered provider is authoritative for path interpretation and filesystem facts used by workspace permission validation. Paths are interpreted lexically; home-relative paths (`~` and `~/...`) and Windows drive-relative paths such as `C:foo` are unsupported. Until provider-side canonicalization is supported, providers must not expose symlinks inside allowed roots that escape those roots.
|
|
17944
19301
|
*
|
|
17945
19302
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17946
19303
|
* via the `definition` "SessionFsSetProviderRequest".
|
|
@@ -17948,7 +19305,7 @@ export interface SessionFsSetProviderCapabilities {
|
|
|
17948
19305
|
/** @experimental */
|
|
17949
19306
|
export interface SessionFsSetProviderRequest {
|
|
17950
19307
|
/**
|
|
17951
|
-
*
|
|
19308
|
+
* Absolute initial working directory for sessions. Registering the provider establishes this path as the root of its virtual namespace; the runtime does not require the provider to materialize or stat it before creating a session.
|
|
17952
19309
|
*/
|
|
17953
19310
|
initialCwd: string;
|
|
17954
19311
|
/**
|
|
@@ -18418,7 +19775,7 @@ export interface SessionLoadDeferredRepoHooksResult {
|
|
|
18418
19775
|
/** @experimental */
|
|
18419
19776
|
export interface SessionManagedPermissions {
|
|
18420
19777
|
/**
|
|
18421
|
-
* When set to `disable`, prevents bypass/allow-all permission modes.
|
|
19778
|
+
* When set to `disable`, prevents bypass/allow-all permission modes. Advisory auto-approval remains available because normal prompt paths stay active. Any other value is accepted rather than failing the session, but is enforced as `disable`: the key is only present to restrict something, so a mode this runtime cannot interpret fails closed to the most restrictive one it knows. Omit the key entirely to impose no restriction.
|
|
18422
19779
|
*/
|
|
18423
19780
|
disableBypassPermissionsMode?: string;
|
|
18424
19781
|
/**
|
|
@@ -18502,6 +19859,7 @@ export interface SessionMetadataSnapshot {
|
|
|
18502
19859
|
* Current session limits, or null when no limits are active
|
|
18503
19860
|
*/
|
|
18504
19861
|
sessionLimits: SessionLimitsConfig | null;
|
|
19862
|
+
indexedSearch?: IndexedSearchState;
|
|
18505
19863
|
/**
|
|
18506
19864
|
* 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).
|
|
18507
19865
|
*/
|
|
@@ -18591,7 +19949,7 @@ export interface SessionOpenOptions {
|
|
|
18591
19949
|
*/
|
|
18592
19950
|
integrationId?: string;
|
|
18593
19951
|
/**
|
|
18594
|
-
* Opt-in: self-fetch and enforce enterprise managed settings at session bootstrap.
|
|
19952
|
+
* Opt-in: self-fetch and enforce enterprise managed settings, including managed hook policies, at session bootstrap.
|
|
18595
19953
|
*/
|
|
18596
19954
|
enableManagedSettings?: boolean;
|
|
18597
19955
|
managedSettings?: SessionManagedSettings;
|
|
@@ -18693,6 +20051,14 @@ export interface SessionOpenOptions {
|
|
|
18693
20051
|
* MCP server names disabled for this session. Disabled servers are not started or authenticated on create or cold resume.
|
|
18694
20052
|
*/
|
|
18695
20053
|
disabledMcpServers?: string[];
|
|
20054
|
+
/**
|
|
20055
|
+
* Non-secret host-managed HTTP MCP servers keyed by stable managed identity. Managed provenance is runtime-established from this separate field and credentials are supplied through dynamic-header refresh.
|
|
20056
|
+
*
|
|
20057
|
+
* @experimental
|
|
20058
|
+
*/
|
|
20059
|
+
managedMcpServers?: {
|
|
20060
|
+
[k: string]: ManagedMcpServerConfig;
|
|
20061
|
+
};
|
|
18696
20062
|
/**
|
|
18697
20063
|
* Whether to include instructions from every MCP server in the system prompt instead of only allowlisted servers.
|
|
18698
20064
|
*/
|
|
@@ -18701,6 +20067,10 @@ export interface SessionOpenOptions {
|
|
|
18701
20067
|
* Additional directories to search for skills.
|
|
18702
20068
|
*/
|
|
18703
20069
|
skillDirectories?: string[];
|
|
20070
|
+
/**
|
|
20071
|
+
* Skill scan directories and descendants excluded from discovery. Supports `~`-relative paths.
|
|
20072
|
+
*/
|
|
20073
|
+
ignoredSkillsLocations?: string[];
|
|
18704
20074
|
/**
|
|
18705
20075
|
* Whether skill loading is enabled. When omitted, an SDK skill provider enables skills by default.
|
|
18706
20076
|
*/
|
|
@@ -19126,6 +20496,45 @@ export interface SessionsOpenProgress {
|
|
|
19126
20496
|
*/
|
|
19127
20497
|
message?: string;
|
|
19128
20498
|
}
|
|
20499
|
+
/**
|
|
20500
|
+
* Plugin names (or specs) to disable in the session's authoritative working directory.
|
|
20501
|
+
*
|
|
20502
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
20503
|
+
* via the `definition` "SessionPluginsDisableRequest".
|
|
20504
|
+
*/
|
|
20505
|
+
/** @experimental */
|
|
20506
|
+
export interface SessionPluginsDisableRequest {
|
|
20507
|
+
/**
|
|
20508
|
+
* Plugin names or "plugin@marketplace" specs to disable. Unknown names are ignored. Non-marketplace direct installs cannot be disabled via this API; uninstall them instead. Plugin-owned MCP servers are stopped in active sessions immediately; other plugin contributions remain available until each session reloads plugins.
|
|
20509
|
+
*/
|
|
20510
|
+
names: string[];
|
|
20511
|
+
}
|
|
20512
|
+
/**
|
|
20513
|
+
* Plugin names (or specs) to enable in the session's authoritative working directory.
|
|
20514
|
+
*
|
|
20515
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
20516
|
+
* via the `definition` "SessionPluginsEnableRequest".
|
|
20517
|
+
*/
|
|
20518
|
+
/** @experimental */
|
|
20519
|
+
export interface SessionPluginsEnableRequest {
|
|
20520
|
+
/**
|
|
20521
|
+
* Plugin names or "plugin@marketplace" specs to enable. Unknown names are ignored. Non-marketplace direct installs are always enabled and cannot be toggled via this API.
|
|
20522
|
+
*/
|
|
20523
|
+
names: string[];
|
|
20524
|
+
}
|
|
20525
|
+
/**
|
|
20526
|
+
* Plugin source resolved relative to the session's authoritative working directory.
|
|
20527
|
+
*
|
|
20528
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
20529
|
+
* via the `definition` "SessionPluginsInstallRequest".
|
|
20530
|
+
*/
|
|
20531
|
+
/** @experimental */
|
|
20532
|
+
export interface SessionPluginsInstallRequest {
|
|
20533
|
+
/**
|
|
20534
|
+
* Plugin install spec. Accepts the same forms as the CLI: "plugin@marketplace" (marketplace install), "owner/repo" or "owner/repo:subpath" (GitHub direct), an http/https/ssh URL, or a local path. Direct (non-marketplace) installs are deprecated and will produce a deprecationWarning in the result.
|
|
20535
|
+
*/
|
|
20536
|
+
source: string;
|
|
20537
|
+
}
|
|
19129
20538
|
/**
|
|
19130
20539
|
* Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag.
|
|
19131
20540
|
*
|
|
@@ -20142,6 +21551,10 @@ export interface SessionUpdateOptionsParams {
|
|
|
20142
21551
|
* Additional directories to search for skills.
|
|
20143
21552
|
*/
|
|
20144
21553
|
skillDirectories?: string[];
|
|
21554
|
+
/**
|
|
21555
|
+
* Skill scan directories and descendants excluded from discovery. Supports `~`-relative paths.
|
|
21556
|
+
*/
|
|
21557
|
+
ignoredSkillsLocations?: string[];
|
|
20145
21558
|
/**
|
|
20146
21559
|
* Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available. Set to null to remove the allowlist restriction.
|
|
20147
21560
|
*/
|
|
@@ -20387,6 +21800,10 @@ export interface ShutdownRequest {
|
|
|
20387
21800
|
* Optional human-readable reason. Typically the message of the error that triggered shutdown when type is 'error'.
|
|
20388
21801
|
*/
|
|
20389
21802
|
reason?: string;
|
|
21803
|
+
/**
|
|
21804
|
+
* Dispatch deferred sessionEnd hooks in the background with their full per-hook timeoutSec instead of awaiting them under the short shared shutdown budget. Set this when the host process keeps running after the session closes (for example the CLI's /clear), so a slow hook neither blocks the close nor is aborted. Hooks still detached when the process later exits are terminated with it. Defaults to false.
|
|
21805
|
+
*/
|
|
21806
|
+
detachSessionEndHooks?: boolean;
|
|
20390
21807
|
}
|
|
20391
21808
|
/**
|
|
20392
21809
|
* Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint.
|
|
@@ -20566,6 +21983,10 @@ export interface SkillsDiscoverRequest {
|
|
|
20566
21983
|
* Optional list of additional skill directory paths to include
|
|
20567
21984
|
*/
|
|
20568
21985
|
skillDirectories?: string[];
|
|
21986
|
+
/**
|
|
21987
|
+
* Optional skill scan paths to exclude from discovery.
|
|
21988
|
+
*/
|
|
21989
|
+
ignoredSkillsLocations?: string[];
|
|
20569
21990
|
/**
|
|
20570
21991
|
* When true, omit skills from the host's global sources (personal, custom, plugin, and built-in), returning only project-scoped skills. For multitenant deployments.
|
|
20571
21992
|
*/
|
|
@@ -20596,6 +22017,10 @@ export interface SkillsGetDiscoveryPathsRequest {
|
|
|
20596
22017
|
* Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned.
|
|
20597
22018
|
*/
|
|
20598
22019
|
projectPaths?: string[];
|
|
22020
|
+
/**
|
|
22021
|
+
* Optional skill scan paths to exclude from discovery.
|
|
22022
|
+
*/
|
|
22023
|
+
ignoredSkillsLocations?: string[];
|
|
20599
22024
|
/**
|
|
20600
22025
|
* When true, omit the host's personal and custom skill directories, leaving only project directories. For multitenant deployments.
|
|
20601
22026
|
*/
|
|
@@ -20776,6 +22201,7 @@ export interface SlashCommandTextResult {
|
|
|
20776
22201
|
* True when the invocation mutated user runtime settings; consumers caching settings should refresh
|
|
20777
22202
|
*/
|
|
20778
22203
|
runtimeSettingsChanged?: boolean;
|
|
22204
|
+
sandboxSessionChange?: SandboxSessionChange;
|
|
20779
22205
|
}
|
|
20780
22206
|
/**
|
|
20781
22207
|
* Slash-command invocation result asking the client to present subcommand options for a parent command.
|
|
@@ -21668,6 +23094,12 @@ export interface Tool {
|
|
|
21668
23094
|
* Optional instructions for how to use this tool effectively
|
|
21669
23095
|
*/
|
|
21670
23096
|
instructions?: string;
|
|
23097
|
+
/**
|
|
23098
|
+
* Telemetry-safety policy for the tool name and input names, not input values. Treat omitted metadata as unsafe.
|
|
23099
|
+
*
|
|
23100
|
+
* @experimental
|
|
23101
|
+
*/
|
|
23102
|
+
safeForTelemetry?: BuiltinToolSafeForTelemetry;
|
|
21671
23103
|
}
|
|
21672
23104
|
/**
|
|
21673
23105
|
* Built-in tools available for the requested model, with their parameters and instructions.
|
|
@@ -22924,113 +24356,1076 @@ export interface VisibilitySetResult {
|
|
|
22924
24356
|
shareUrl?: string;
|
|
22925
24357
|
}
|
|
22926
24358
|
/**
|
|
22927
|
-
*
|
|
24359
|
+
* Parameters for cooperatively aborting a workflow body.
|
|
22928
24360
|
*
|
|
22929
24361
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
22930
|
-
* via the `definition` "
|
|
24362
|
+
* via the `definition` "WorkflowAbortRequest".
|
|
22931
24363
|
*/
|
|
22932
24364
|
/** @experimental */
|
|
22933
|
-
export interface
|
|
22934
|
-
/**
|
|
22935
|
-
* Path to the changed file, relative to the workspace root when the file lives under it. A file changed outside the workspace root keeps a `../`-relative path, or an absolute path when no relative path exists (for example a different Windows drive).
|
|
22936
|
-
*/
|
|
22937
|
-
path: string;
|
|
24365
|
+
export interface WorkflowAbortRequest {
|
|
22938
24366
|
/**
|
|
22939
|
-
*
|
|
24367
|
+
* Target session identifier
|
|
22940
24368
|
*/
|
|
22941
|
-
|
|
22942
|
-
changeType: WorkspaceDiffFileChangeType;
|
|
24369
|
+
sessionId: string;
|
|
22943
24370
|
/**
|
|
22944
|
-
*
|
|
24371
|
+
* Workflow run identifier.
|
|
22945
24372
|
*/
|
|
22946
|
-
|
|
24373
|
+
runId: string;
|
|
22947
24374
|
/**
|
|
22948
|
-
*
|
|
24375
|
+
* Opaque token identifying the execution attempt to abort.
|
|
22949
24376
|
*/
|
|
22950
|
-
|
|
24377
|
+
executionToken: string;
|
|
22951
24378
|
}
|
|
22952
24379
|
/**
|
|
22953
|
-
*
|
|
24380
|
+
* Acknowledgement that a workflow request was accepted.
|
|
22954
24381
|
*
|
|
22955
24382
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
22956
|
-
* via the `definition` "
|
|
24383
|
+
* via the `definition` "WorkflowAckResult".
|
|
22957
24384
|
*/
|
|
22958
24385
|
/** @experimental */
|
|
22959
|
-
export interface
|
|
22960
|
-
requestedMode: WorkspaceDiffMode;
|
|
22961
|
-
mode: WorkspaceDiffMode;
|
|
22962
|
-
/**
|
|
22963
|
-
* Changed files and their unified diffs.
|
|
22964
|
-
*/
|
|
22965
|
-
changes: WorkspaceDiffFileChange[];
|
|
22966
|
-
/**
|
|
22967
|
-
* Default branch used for a branch diff, when branch mode was requested.
|
|
22968
|
-
*/
|
|
22969
|
-
baseBranch?: string;
|
|
22970
|
-
/**
|
|
22971
|
-
* Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable.
|
|
22972
|
-
*/
|
|
22973
|
-
isFallback: boolean;
|
|
22974
|
-
unavailableReason?: HistoryRewindUnavailableReason;
|
|
24386
|
+
export interface WorkflowAckResult {
|
|
22975
24387
|
}
|
|
22976
24388
|
/**
|
|
22977
|
-
*
|
|
24389
|
+
* Options for one workflow-scoped subagent call.
|
|
22978
24390
|
*
|
|
22979
24391
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
22980
|
-
* via the `definition` "
|
|
24392
|
+
* via the `definition` "WorkflowAgentOptions".
|
|
22981
24393
|
*/
|
|
22982
24394
|
/** @experimental */
|
|
22983
|
-
export interface
|
|
24395
|
+
export interface WorkflowAgentOptions {
|
|
22984
24396
|
/**
|
|
22985
|
-
*
|
|
24397
|
+
* Optional label distinguishing otherwise identical memoized agent calls.
|
|
22986
24398
|
*/
|
|
22987
|
-
|
|
24399
|
+
label?: string;
|
|
22988
24400
|
/**
|
|
22989
|
-
*
|
|
24401
|
+
* Optional JSON Schema for structured agent output.
|
|
22990
24402
|
*/
|
|
22991
|
-
|
|
24403
|
+
schema?: JsonValue;
|
|
24404
|
+
/**
|
|
24405
|
+
* Optional model identifier for the subagent.
|
|
24406
|
+
*/
|
|
24407
|
+
model?: string;
|
|
24408
|
+
/**
|
|
24409
|
+
* Optional reasoning effort override for the subagent.
|
|
24410
|
+
*/
|
|
24411
|
+
reasoningEffort?: string;
|
|
24412
|
+
contextTier?: ContextTier;
|
|
24413
|
+
/**
|
|
24414
|
+
* Optional built-in or custom agent name whose definition configures the subagent.
|
|
24415
|
+
*/
|
|
24416
|
+
agent?: string;
|
|
22992
24417
|
}
|
|
22993
24418
|
/**
|
|
22994
|
-
*
|
|
24419
|
+
* Parameters for one workflow-scoped subagent call.
|
|
22995
24420
|
*
|
|
22996
24421
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
22997
|
-
* via the `definition` "
|
|
24422
|
+
* via the `definition` "WorkflowAgentRequest".
|
|
22998
24423
|
*/
|
|
22999
24424
|
/** @experimental */
|
|
23000
|
-
export interface
|
|
24425
|
+
export interface WorkflowAgentRequest {
|
|
23001
24426
|
/**
|
|
23002
|
-
*
|
|
24427
|
+
* Workflow run identifier that owns the subagent.
|
|
23003
24428
|
*/
|
|
23004
|
-
|
|
24429
|
+
workflowRunId: string;
|
|
23005
24430
|
/**
|
|
23006
|
-
*
|
|
24431
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
23007
24432
|
*/
|
|
23008
|
-
|
|
23009
|
-
|
|
24433
|
+
executionToken: string;
|
|
24434
|
+
/**
|
|
24435
|
+
* Prompt to send to the subagent.
|
|
24436
|
+
*/
|
|
24437
|
+
prompt: string;
|
|
24438
|
+
opts: WorkflowAgentOptions;
|
|
23010
24439
|
}
|
|
23011
24440
|
/**
|
|
23012
|
-
*
|
|
24441
|
+
* Result of one workflow-scoped subagent call.
|
|
23013
24442
|
*
|
|
23014
24443
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23015
|
-
* via the `definition` "
|
|
24444
|
+
* via the `definition` "WorkflowAgentResult".
|
|
23016
24445
|
*/
|
|
23017
24446
|
/** @experimental */
|
|
23018
|
-
export interface
|
|
24447
|
+
export interface WorkflowAgentResult {
|
|
23019
24448
|
/**
|
|
23020
|
-
*
|
|
24449
|
+
* Agent result, omitted when the agent produced no result.
|
|
23021
24450
|
*/
|
|
23022
|
-
|
|
24451
|
+
result?: JsonValue;
|
|
23023
24452
|
}
|
|
23024
24453
|
/**
|
|
23025
|
-
*
|
|
24454
|
+
* Prompt-safe durable identity and live status for a direct workflow agent.
|
|
23026
24455
|
*
|
|
23027
24456
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23028
|
-
* via the `definition` "
|
|
24457
|
+
* via the `definition` "WorkflowAgentSummary".
|
|
23029
24458
|
*/
|
|
23030
24459
|
/** @experimental */
|
|
23031
|
-
export interface
|
|
24460
|
+
export interface WorkflowAgentSummary {
|
|
23032
24461
|
/**
|
|
23033
|
-
*
|
|
24462
|
+
* Stable direct-agent identifier.
|
|
24463
|
+
*/
|
|
24464
|
+
agentId: string;
|
|
24465
|
+
/**
|
|
24466
|
+
* Tool-call identifier that launched the agent.
|
|
24467
|
+
*/
|
|
24468
|
+
toolCallId: string;
|
|
24469
|
+
/**
|
|
24470
|
+
* Owning workflow run identifier.
|
|
24471
|
+
*/
|
|
24472
|
+
runId: string;
|
|
24473
|
+
/**
|
|
24474
|
+
* Phase identifier active when the agent was launched, or null.
|
|
24475
|
+
*/
|
|
24476
|
+
phaseId: string | null;
|
|
24477
|
+
/**
|
|
24478
|
+
* Friendly, non-unique name intended for display
|
|
24479
|
+
*/
|
|
24480
|
+
label: string;
|
|
24481
|
+
/**
|
|
24482
|
+
* Friendly, non-unique name intended for display
|
|
24483
|
+
*/
|
|
24484
|
+
displayName?: string;
|
|
24485
|
+
/**
|
|
24486
|
+
* Registered agent type.
|
|
24487
|
+
*/
|
|
24488
|
+
agentType: string;
|
|
24489
|
+
/**
|
|
24490
|
+
* Current durable or live agent status.
|
|
24491
|
+
*/
|
|
24492
|
+
status: string;
|
|
24493
|
+
/**
|
|
24494
|
+
* Model requested when the agent was launched.
|
|
24495
|
+
*/
|
|
24496
|
+
requestedModel?: string;
|
|
24497
|
+
/**
|
|
24498
|
+
* Concrete model resolved for the agent.
|
|
24499
|
+
*/
|
|
24500
|
+
resolvedModel?: string;
|
|
24501
|
+
/**
|
|
24502
|
+
* Epoch milliseconds when the agent started.
|
|
24503
|
+
*/
|
|
24504
|
+
startedAt?: number;
|
|
24505
|
+
/**
|
|
24506
|
+
* Epoch milliseconds when the agent completed.
|
|
24507
|
+
*/
|
|
24508
|
+
completedAt?: number;
|
|
24509
|
+
/**
|
|
24510
|
+
* Accumulated active agent time in milliseconds.
|
|
24511
|
+
*/
|
|
24512
|
+
activeMs: number;
|
|
24513
|
+
/**
|
|
24514
|
+
* Prompt-safe live activity text.
|
|
24515
|
+
*/
|
|
24516
|
+
activity?: string;
|
|
24517
|
+
}
|
|
24518
|
+
/**
|
|
24519
|
+
* Parameters for cancelling a workflow run.
|
|
24520
|
+
*
|
|
24521
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24522
|
+
* via the `definition` "WorkflowCancelRequest".
|
|
24523
|
+
*/
|
|
24524
|
+
/** @experimental */
|
|
24525
|
+
export interface WorkflowCancelRequest {
|
|
24526
|
+
/**
|
|
24527
|
+
* Workflow run identifier.
|
|
24528
|
+
*/
|
|
24529
|
+
runId: string;
|
|
24530
|
+
}
|
|
24531
|
+
/**
|
|
24532
|
+
* Current workflow phase identity.
|
|
24533
|
+
*
|
|
24534
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24535
|
+
* via the `definition` "WorkflowCurrentPhase".
|
|
24536
|
+
*/
|
|
24537
|
+
/** @experimental */
|
|
24538
|
+
export interface WorkflowCurrentPhase {
|
|
24539
|
+
/**
|
|
24540
|
+
* Current phase identifier.
|
|
24541
|
+
*/
|
|
24542
|
+
id: string;
|
|
24543
|
+
/**
|
|
24544
|
+
* Zero-based declared phase ordinal, or null for an undeclared phase.
|
|
24545
|
+
*/
|
|
24546
|
+
ordinal: number | null;
|
|
24547
|
+
}
|
|
24548
|
+
/**
|
|
24549
|
+
* Declared or approved workflow resource ceilings.
|
|
24550
|
+
*
|
|
24551
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24552
|
+
* via the `definition` "WorkflowDeclaredLimits".
|
|
24553
|
+
*/
|
|
24554
|
+
/** @experimental */
|
|
24555
|
+
export interface WorkflowDeclaredLimits {
|
|
24556
|
+
/**
|
|
24557
|
+
* Maximum concurrently active subagents.
|
|
24558
|
+
*/
|
|
24559
|
+
maxConcurrentSubagents?: number;
|
|
24560
|
+
/**
|
|
24561
|
+
* Maximum total subagents spawned by the run.
|
|
24562
|
+
*/
|
|
24563
|
+
maxTotalSubagents?: number;
|
|
24564
|
+
/**
|
|
24565
|
+
* Maximum accumulated active execution time in seconds.
|
|
24566
|
+
*/
|
|
24567
|
+
timeoutSeconds?: number;
|
|
24568
|
+
/**
|
|
24569
|
+
* Maximum AI credits consumed by subagents and descendants.
|
|
24570
|
+
*/
|
|
24571
|
+
maxAiCredits?: number;
|
|
24572
|
+
}
|
|
24573
|
+
/**
|
|
24574
|
+
* Parameters sent to the owning extension to execute a workflow closure.
|
|
24575
|
+
*
|
|
24576
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24577
|
+
* via the `definition` "WorkflowExecuteRequest".
|
|
24578
|
+
*/
|
|
24579
|
+
/** @experimental */
|
|
24580
|
+
export interface WorkflowExecuteRequest {
|
|
24581
|
+
/**
|
|
24582
|
+
* Target session identifier
|
|
24583
|
+
*/
|
|
24584
|
+
sessionId: string;
|
|
24585
|
+
/**
|
|
24586
|
+
* Registered workflow name.
|
|
24587
|
+
*/
|
|
24588
|
+
name: string;
|
|
24589
|
+
/**
|
|
24590
|
+
* Workflow run identifier.
|
|
24591
|
+
*/
|
|
24592
|
+
runId: string;
|
|
24593
|
+
/**
|
|
24594
|
+
* Opaque token identifying this workflow execution attempt.
|
|
24595
|
+
*/
|
|
24596
|
+
executionToken: string;
|
|
24597
|
+
/**
|
|
24598
|
+
* Workflow input value.
|
|
24599
|
+
*/
|
|
24600
|
+
args: JsonValue;
|
|
24601
|
+
}
|
|
24602
|
+
/**
|
|
24603
|
+
* Result returned by an extension workflow closure.
|
|
24604
|
+
*
|
|
24605
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24606
|
+
* via the `definition` "WorkflowExecuteResult".
|
|
24607
|
+
*/
|
|
24608
|
+
/** @experimental */
|
|
24609
|
+
export interface WorkflowExecuteResult {
|
|
24610
|
+
/**
|
|
24611
|
+
* Workflow result value.
|
|
24612
|
+
*/
|
|
24613
|
+
result?: JsonValue;
|
|
24614
|
+
}
|
|
24615
|
+
/**
|
|
24616
|
+
* Parameters for paging workflow progress.
|
|
24617
|
+
*
|
|
24618
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24619
|
+
* via the `definition` "WorkflowGetRunProgressRequest".
|
|
24620
|
+
*/
|
|
24621
|
+
/** @experimental */
|
|
24622
|
+
export interface WorkflowGetRunProgressRequest {
|
|
24623
|
+
/**
|
|
24624
|
+
* Workflow run identifier.
|
|
24625
|
+
*/
|
|
24626
|
+
runId: string;
|
|
24627
|
+
/**
|
|
24628
|
+
* Optional phase identifier used to scope records and cursors.
|
|
24629
|
+
*/
|
|
24630
|
+
phaseId?: string;
|
|
24631
|
+
/**
|
|
24632
|
+
* Exclusive forward cursor.
|
|
24633
|
+
*/
|
|
24634
|
+
afterSeq?: number;
|
|
24635
|
+
/**
|
|
24636
|
+
* Exclusive backward cursor.
|
|
24637
|
+
*/
|
|
24638
|
+
beforeSeq?: number;
|
|
24639
|
+
/**
|
|
24640
|
+
* Maximum records to return. Defaults to 200 and is capped at 500.
|
|
24641
|
+
*/
|
|
24642
|
+
limit?: number;
|
|
24643
|
+
}
|
|
24644
|
+
/**
|
|
24645
|
+
* Parameters for retrieving a workflow run.
|
|
24646
|
+
*
|
|
24647
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24648
|
+
* via the `definition` "WorkflowGetRunRequest".
|
|
24649
|
+
*/
|
|
24650
|
+
/** @experimental */
|
|
24651
|
+
export interface WorkflowGetRunRequest {
|
|
24652
|
+
/**
|
|
24653
|
+
* Workflow run identifier.
|
|
24654
|
+
*/
|
|
24655
|
+
runId: string;
|
|
24656
|
+
}
|
|
24657
|
+
/**
|
|
24658
|
+
* Parameters for reading a workflow journal entry.
|
|
24659
|
+
*
|
|
24660
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24661
|
+
* via the `definition` "WorkflowJournalGetRequest".
|
|
24662
|
+
*/
|
|
24663
|
+
/** @experimental */
|
|
24664
|
+
export interface WorkflowJournalGetRequest {
|
|
24665
|
+
/**
|
|
24666
|
+
* Workflow run identifier.
|
|
24667
|
+
*/
|
|
24668
|
+
runId: string;
|
|
24669
|
+
/**
|
|
24670
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
24671
|
+
*/
|
|
24672
|
+
executionToken: string;
|
|
24673
|
+
/**
|
|
24674
|
+
* Namespaced journal key.
|
|
24675
|
+
*/
|
|
24676
|
+
key: string;
|
|
24677
|
+
}
|
|
24678
|
+
/**
|
|
24679
|
+
* Result of reading a workflow journal entry.
|
|
24680
|
+
*
|
|
24681
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24682
|
+
* via the `definition` "WorkflowJournalGetResult".
|
|
24683
|
+
*/
|
|
24684
|
+
/** @experimental */
|
|
24685
|
+
export interface WorkflowJournalGetResult {
|
|
24686
|
+
/**
|
|
24687
|
+
* Whether the journal contained the requested key.
|
|
24688
|
+
*/
|
|
24689
|
+
hit: boolean;
|
|
24690
|
+
/**
|
|
24691
|
+
* Cached JSON result. The hit field distinguishes a cached JSON null from a miss.
|
|
24692
|
+
*/
|
|
24693
|
+
resultJson?: JsonValue;
|
|
24694
|
+
}
|
|
24695
|
+
/**
|
|
24696
|
+
* Parameters for storing a workflow journal entry.
|
|
24697
|
+
*
|
|
24698
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24699
|
+
* via the `definition` "WorkflowJournalPutRequest".
|
|
24700
|
+
*/
|
|
24701
|
+
/** @experimental */
|
|
24702
|
+
export interface WorkflowJournalPutRequest {
|
|
24703
|
+
/**
|
|
24704
|
+
* Workflow run identifier.
|
|
24705
|
+
*/
|
|
24706
|
+
runId: string;
|
|
24707
|
+
/**
|
|
24708
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
24709
|
+
*/
|
|
24710
|
+
executionToken: string;
|
|
24711
|
+
/**
|
|
24712
|
+
* Namespaced journal key.
|
|
24713
|
+
*/
|
|
24714
|
+
key: string;
|
|
24715
|
+
/**
|
|
24716
|
+
* JSON result to memoize.
|
|
24717
|
+
*/
|
|
24718
|
+
resultJson: JsonValue;
|
|
24719
|
+
}
|
|
24720
|
+
/**
|
|
24721
|
+
* Parameters for paging workflow runs.
|
|
24722
|
+
*
|
|
24723
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24724
|
+
* via the `definition` "WorkflowListRunsRequest".
|
|
24725
|
+
*/
|
|
24726
|
+
/** @experimental */
|
|
24727
|
+
export interface WorkflowListRunsRequest {
|
|
24728
|
+
/**
|
|
24729
|
+
* Exclusive forward cursor.
|
|
24730
|
+
*/
|
|
24731
|
+
afterSeq?: number;
|
|
24732
|
+
/**
|
|
24733
|
+
* Exclusive backward cursor.
|
|
24734
|
+
*/
|
|
24735
|
+
beforeSeq?: number;
|
|
24736
|
+
/**
|
|
24737
|
+
* Maximum terminal runs to return. Defaults to 200 and is capped at 500.
|
|
24738
|
+
*/
|
|
24739
|
+
limit?: number;
|
|
24740
|
+
}
|
|
24741
|
+
/**
|
|
24742
|
+
* A page of workflow runs in durable creation order.
|
|
24743
|
+
*
|
|
24744
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24745
|
+
* via the `definition` "WorkflowListRunsResult".
|
|
24746
|
+
*/
|
|
24747
|
+
/** @experimental */
|
|
24748
|
+
export interface WorkflowListRunsResult {
|
|
24749
|
+
/**
|
|
24750
|
+
* Workflow run summaries in durable creation order.
|
|
24751
|
+
*/
|
|
24752
|
+
runs: WorkflowRunSummary[];
|
|
24753
|
+
/**
|
|
24754
|
+
* Oldest terminal-run cursor in this page, or null when the terminal window is empty.
|
|
24755
|
+
*/
|
|
24756
|
+
oldestSeq?: number | null;
|
|
24757
|
+
/**
|
|
24758
|
+
* Newest terminal-run cursor in this page, or null when the terminal window is empty.
|
|
24759
|
+
*/
|
|
24760
|
+
newestSeq?: number | null;
|
|
24761
|
+
/**
|
|
24762
|
+
* Whether terminal runs newer than this page exist.
|
|
24763
|
+
*/
|
|
24764
|
+
hasMoreNewer?: boolean;
|
|
24765
|
+
/**
|
|
24766
|
+
* Number of terminal runs older than this page.
|
|
24767
|
+
*/
|
|
24768
|
+
omittedOlder?: number;
|
|
24769
|
+
}
|
|
24770
|
+
/**
|
|
24771
|
+
* Durable workflow run summary with read-time live overlays.
|
|
24772
|
+
*
|
|
24773
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24774
|
+
* via the `definition` "WorkflowRunSummary".
|
|
24775
|
+
*/
|
|
24776
|
+
/** @experimental */
|
|
24777
|
+
export interface WorkflowRunSummary {
|
|
24778
|
+
/**
|
|
24779
|
+
* Workflow run identifier.
|
|
24780
|
+
*/
|
|
24781
|
+
runId: string;
|
|
24782
|
+
/**
|
|
24783
|
+
* Registered workflow name.
|
|
24784
|
+
*/
|
|
24785
|
+
workflowName: string;
|
|
24786
|
+
/**
|
|
24787
|
+
* Human-readable workflow description.
|
|
24788
|
+
*/
|
|
24789
|
+
description: string;
|
|
24790
|
+
status: WorkflowRunStatus;
|
|
24791
|
+
/**
|
|
24792
|
+
* Monotonic durable run revision.
|
|
24793
|
+
*/
|
|
24794
|
+
revision: number;
|
|
24795
|
+
/**
|
|
24796
|
+
* Epoch milliseconds when the run was created.
|
|
24797
|
+
*/
|
|
24798
|
+
createdAt: number;
|
|
24799
|
+
/**
|
|
24800
|
+
* Epoch milliseconds when execution first started, or null before start.
|
|
24801
|
+
*/
|
|
24802
|
+
startedAt: number | null;
|
|
24803
|
+
/**
|
|
24804
|
+
* Epoch milliseconds when the durable run was last updated.
|
|
24805
|
+
*/
|
|
24806
|
+
updatedAt: number;
|
|
24807
|
+
/**
|
|
24808
|
+
* Epoch milliseconds when the run completed, or null while nonterminal.
|
|
24809
|
+
*/
|
|
24810
|
+
completedAt: number | null;
|
|
24811
|
+
/**
|
|
24812
|
+
* Current phase identity, or null before any phase is entered.
|
|
24813
|
+
*/
|
|
24814
|
+
currentPhase: WorkflowCurrentPhase | null;
|
|
24815
|
+
/**
|
|
24816
|
+
* Number of phases declared by the workflow.
|
|
24817
|
+
*/
|
|
24818
|
+
declaredPhaseCount: number;
|
|
24819
|
+
/**
|
|
24820
|
+
* Number of direct workflow agents currently live.
|
|
24821
|
+
*/
|
|
24822
|
+
liveAgentCount: number;
|
|
24823
|
+
/**
|
|
24824
|
+
* Total direct workflow agents spawned across all attempts.
|
|
24825
|
+
*/
|
|
24826
|
+
totalSpawnedAgentCount: number;
|
|
24827
|
+
consumed: WorkflowRunConsumed;
|
|
24828
|
+
declaredLimits: WorkflowDeclaredLimits;
|
|
24829
|
+
/**
|
|
24830
|
+
* Approved effective resource ceilings, or null until approved.
|
|
24831
|
+
*/
|
|
24832
|
+
approved: WorkflowDeclaredLimits | null;
|
|
24833
|
+
/**
|
|
24834
|
+
* Epoch milliseconds when this live-overlay snapshot was observed.
|
|
24835
|
+
*/
|
|
24836
|
+
observedAt: number;
|
|
24837
|
+
/**
|
|
24838
|
+
* Epoch milliseconds when the current active segment started, or null while inactive.
|
|
24839
|
+
*/
|
|
24840
|
+
activeSegmentStartedAt: number | null;
|
|
24841
|
+
/**
|
|
24842
|
+
* Terminal run outcome, or null while nonterminal.
|
|
24843
|
+
*/
|
|
24844
|
+
terminal: WorkflowRunTerminal | null;
|
|
24845
|
+
/**
|
|
24846
|
+
* Whether the durable run state currently passes runtime resume eligibility checks.
|
|
24847
|
+
*/
|
|
24848
|
+
canResume: boolean;
|
|
24849
|
+
}
|
|
24850
|
+
/**
|
|
24851
|
+
* Durable workflow resource consumption.
|
|
24852
|
+
*
|
|
24853
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24854
|
+
* via the `definition` "WorkflowRunConsumed".
|
|
24855
|
+
*/
|
|
24856
|
+
/** @experimental */
|
|
24857
|
+
export interface WorkflowRunConsumed {
|
|
24858
|
+
/**
|
|
24859
|
+
* Accumulated active execution time in milliseconds.
|
|
24860
|
+
*/
|
|
24861
|
+
activeMs: number;
|
|
24862
|
+
/**
|
|
24863
|
+
* Total subagents spawned by the run.
|
|
24864
|
+
*/
|
|
24865
|
+
subagents: number;
|
|
24866
|
+
/**
|
|
24867
|
+
* AI usage consumed by the run in nano-AIU.
|
|
24868
|
+
*/
|
|
24869
|
+
nanoAiu: number;
|
|
24870
|
+
}
|
|
24871
|
+
/**
|
|
24872
|
+
* Prompt-safe terminal workflow outcome.
|
|
24873
|
+
*
|
|
24874
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24875
|
+
* via the `definition` "WorkflowRunTerminal".
|
|
24876
|
+
*/
|
|
24877
|
+
/** @experimental */
|
|
24878
|
+
export interface WorkflowRunTerminal {
|
|
24879
|
+
/**
|
|
24880
|
+
* Human-readable terminal reason.
|
|
24881
|
+
*/
|
|
24882
|
+
reason?: string;
|
|
24883
|
+
failure?: WorkflowRunFailure;
|
|
24884
|
+
/**
|
|
24885
|
+
* Human-readable terminal error.
|
|
24886
|
+
*/
|
|
24887
|
+
error?: string;
|
|
24888
|
+
/**
|
|
24889
|
+
* Prompt-safe preview of the completed result.
|
|
24890
|
+
*/
|
|
24891
|
+
resultPreview?: string;
|
|
24892
|
+
/**
|
|
24893
|
+
* Pause initiator metadata, or null when the run did not pause.
|
|
24894
|
+
*/
|
|
24895
|
+
pauseInfo: WorkflowPauseInfo | null;
|
|
24896
|
+
}
|
|
24897
|
+
/**
|
|
24898
|
+
* One ordered workflow progress line.
|
|
24899
|
+
*
|
|
24900
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24901
|
+
* via the `definition` "WorkflowLogLine".
|
|
24902
|
+
*/
|
|
24903
|
+
/** @experimental */
|
|
24904
|
+
export interface WorkflowLogLine {
|
|
24905
|
+
/**
|
|
24906
|
+
* Monotonic sequence number within the workflow run.
|
|
24907
|
+
*/
|
|
24908
|
+
seq: number;
|
|
24909
|
+
kind: WorkflowLogLineKind;
|
|
24910
|
+
/**
|
|
24911
|
+
* Progress text.
|
|
24912
|
+
*/
|
|
24913
|
+
text: string;
|
|
24914
|
+
}
|
|
24915
|
+
/**
|
|
24916
|
+
* Parameters for recording workflow progress.
|
|
24917
|
+
*
|
|
24918
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24919
|
+
* via the `definition` "WorkflowLogRequest".
|
|
24920
|
+
*/
|
|
24921
|
+
/** @experimental */
|
|
24922
|
+
export interface WorkflowLogRequest {
|
|
24923
|
+
/**
|
|
24924
|
+
* Workflow run identifier.
|
|
24925
|
+
*/
|
|
24926
|
+
runId: string;
|
|
24927
|
+
/**
|
|
24928
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
24929
|
+
*/
|
|
24930
|
+
executionToken: string;
|
|
24931
|
+
/**
|
|
24932
|
+
* Ordered progress lines to append.
|
|
24933
|
+
*/
|
|
24934
|
+
lines: WorkflowLogLine[];
|
|
24935
|
+
}
|
|
24936
|
+
/**
|
|
24937
|
+
* Parameters for an owned durable pause checkpoint.
|
|
24938
|
+
*
|
|
24939
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24940
|
+
* via the `definition` "WorkflowPauseCheckpointRequest".
|
|
24941
|
+
*/
|
|
24942
|
+
/** @experimental */
|
|
24943
|
+
export interface WorkflowPauseCheckpointRequest {
|
|
24944
|
+
/**
|
|
24945
|
+
* Workflow run identifier.
|
|
24946
|
+
*/
|
|
24947
|
+
runId: string;
|
|
24948
|
+
/**
|
|
24949
|
+
* Opaque token identifying the execution attempt that reached the checkpoint.
|
|
24950
|
+
*/
|
|
24951
|
+
executionToken: string;
|
|
24952
|
+
/**
|
|
24953
|
+
* Stable author-defined checkpoint key.
|
|
24954
|
+
*/
|
|
24955
|
+
key: string;
|
|
24956
|
+
}
|
|
24957
|
+
/** @experimental */
|
|
24958
|
+
export interface WorkflowPauseCheckpointResult {
|
|
24959
|
+
action: WorkflowPauseCheckpointAction;
|
|
24960
|
+
}
|
|
24961
|
+
/**
|
|
24962
|
+
* Parameters for pausing a running workflow.
|
|
24963
|
+
*
|
|
24964
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24965
|
+
* via the `definition` "WorkflowPauseRequest".
|
|
24966
|
+
*/
|
|
24967
|
+
/** @experimental */
|
|
24968
|
+
export interface WorkflowPauseRequest {
|
|
24969
|
+
/**
|
|
24970
|
+
* Workflow run identifier.
|
|
24971
|
+
*/
|
|
24972
|
+
runId: string;
|
|
24973
|
+
}
|
|
24974
|
+
/**
|
|
24975
|
+
* Durable lifecycle and timing for one workflow phase.
|
|
24976
|
+
*
|
|
24977
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24978
|
+
* via the `definition` "WorkflowPhaseObservation".
|
|
24979
|
+
*/
|
|
24980
|
+
/** @experimental */
|
|
24981
|
+
export interface WorkflowPhaseObservation {
|
|
24982
|
+
/**
|
|
24983
|
+
* Phase identifier.
|
|
24984
|
+
*/
|
|
24985
|
+
id: string;
|
|
24986
|
+
/**
|
|
24987
|
+
* Zero-based declared phase ordinal, or null for an undeclared phase.
|
|
24988
|
+
*/
|
|
24989
|
+
ordinal: number | null;
|
|
24990
|
+
/**
|
|
24991
|
+
* Human-readable phase title.
|
|
24992
|
+
*/
|
|
24993
|
+
title: string;
|
|
24994
|
+
/**
|
|
24995
|
+
* Optional human-readable phase detail.
|
|
24996
|
+
*/
|
|
24997
|
+
detail?: string;
|
|
24998
|
+
status: WorkflowPhaseStatus;
|
|
24999
|
+
/**
|
|
25000
|
+
* Most recent run attempt that entered this phase, or `0` if the phase has never been entered.
|
|
25001
|
+
*/
|
|
25002
|
+
lastEnteredRunAttempt: number;
|
|
25003
|
+
/**
|
|
25004
|
+
* Number of times execution entered this phase.
|
|
25005
|
+
*/
|
|
25006
|
+
entryCount: number;
|
|
25007
|
+
/**
|
|
25008
|
+
* Epoch milliseconds when this phase first started; for a skipped phase, the synthetic skip timestamp (equal to `completedAt`).
|
|
25009
|
+
*/
|
|
25010
|
+
startedAt?: number;
|
|
25011
|
+
/**
|
|
25012
|
+
* Epoch milliseconds when this phase completed; for a skipped phase, the synthetic skip timestamp (equal to `startedAt`).
|
|
25013
|
+
*/
|
|
25014
|
+
completedAt?: number;
|
|
25015
|
+
/**
|
|
25016
|
+
* Completed active time accumulated by this phase in milliseconds.
|
|
25017
|
+
*/
|
|
25018
|
+
accumulatedActiveMs: number;
|
|
25019
|
+
/**
|
|
25020
|
+
* Current live active time for this phase in milliseconds.
|
|
25021
|
+
*/
|
|
25022
|
+
currentActiveMs: number;
|
|
25023
|
+
/**
|
|
25024
|
+
* Total direct agents associated with this phase.
|
|
25025
|
+
*/
|
|
25026
|
+
totalAgentCount: number;
|
|
25027
|
+
/**
|
|
25028
|
+
* Direct agents in this phase that are currently live.
|
|
25029
|
+
*/
|
|
25030
|
+
liveAgentCount: number;
|
|
25031
|
+
}
|
|
25032
|
+
/**
|
|
25033
|
+
* One durable workflow progress record.
|
|
25034
|
+
*
|
|
25035
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25036
|
+
* via the `definition` "WorkflowProgressLine".
|
|
25037
|
+
*/
|
|
25038
|
+
/** @experimental */
|
|
25039
|
+
export interface WorkflowProgressLine {
|
|
25040
|
+
/**
|
|
25041
|
+
* Global monotonic sequence number within the run.
|
|
25042
|
+
*/
|
|
25043
|
+
seq: number;
|
|
25044
|
+
/**
|
|
25045
|
+
* Resume attempt that emitted this record.
|
|
25046
|
+
*/
|
|
25047
|
+
attempt: number;
|
|
25048
|
+
/**
|
|
25049
|
+
* Phase active when the record was emitted, or null before any phase.
|
|
25050
|
+
*/
|
|
25051
|
+
phaseId: string | null;
|
|
25052
|
+
/**
|
|
25053
|
+
* Epoch milliseconds when the record was persisted.
|
|
25054
|
+
*/
|
|
25055
|
+
recordedAt: number;
|
|
25056
|
+
kind: WorkflowLogLineKind;
|
|
25057
|
+
/**
|
|
25058
|
+
* Prompt-safe progress text.
|
|
25059
|
+
*/
|
|
25060
|
+
text: string;
|
|
25061
|
+
}
|
|
25062
|
+
/**
|
|
25063
|
+
* A bidirectional page of workflow progress.
|
|
25064
|
+
*
|
|
25065
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25066
|
+
* via the `definition` "WorkflowProgressPage".
|
|
25067
|
+
*/
|
|
25068
|
+
/** @experimental */
|
|
25069
|
+
export interface WorkflowProgressPage {
|
|
25070
|
+
/**
|
|
25071
|
+
* Progress records in sequence order.
|
|
25072
|
+
*/
|
|
25073
|
+
records: WorkflowProgressLine[];
|
|
25074
|
+
/**
|
|
25075
|
+
* Oldest sequence number in this page, or null when empty.
|
|
25076
|
+
*/
|
|
25077
|
+
oldestSeq: number | null;
|
|
25078
|
+
/**
|
|
25079
|
+
* Newest sequence number in this page, or null when empty.
|
|
25080
|
+
*/
|
|
25081
|
+
newestSeq: number | null;
|
|
25082
|
+
/**
|
|
25083
|
+
* Whether progress records older than this page exist.
|
|
25084
|
+
*/
|
|
25085
|
+
hasMoreOlder: boolean;
|
|
25086
|
+
/**
|
|
25087
|
+
* Whether progress records newer than this page exist.
|
|
25088
|
+
*/
|
|
25089
|
+
hasMoreNewer: boolean;
|
|
25090
|
+
/**
|
|
25091
|
+
* Run revision reflected by this page.
|
|
25092
|
+
*/
|
|
25093
|
+
revision: number;
|
|
25094
|
+
}
|
|
25095
|
+
/**
|
|
25096
|
+
* Parameters for resuming a workflow run from its persisted identity.
|
|
25097
|
+
*
|
|
25098
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25099
|
+
* via the `definition` "WorkflowResumeRequest".
|
|
25100
|
+
*/
|
|
25101
|
+
/** @experimental */
|
|
25102
|
+
export interface WorkflowResumeRequest {
|
|
25103
|
+
/**
|
|
25104
|
+
* Workflow run identifier.
|
|
25105
|
+
*/
|
|
25106
|
+
runId: string;
|
|
25107
|
+
limits?: WorkflowRunLimits;
|
|
25108
|
+
/**
|
|
25109
|
+
* Whether to notify the originating session when the workflow completes.
|
|
25110
|
+
*/
|
|
25111
|
+
notifyOnComplete?: boolean;
|
|
25112
|
+
/**
|
|
25113
|
+
* Whether to emit workflow phase names to the session transcript.
|
|
25114
|
+
*/
|
|
25115
|
+
logPhaseNames?: boolean;
|
|
25116
|
+
}
|
|
25117
|
+
/**
|
|
25118
|
+
* Wire-only per-invocation workflow resource ceiling overrides.
|
|
25119
|
+
*
|
|
25120
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25121
|
+
* via the `definition` "WorkflowRunLimits".
|
|
25122
|
+
*/
|
|
25123
|
+
/** @experimental */
|
|
25124
|
+
export interface WorkflowRunLimits {
|
|
25125
|
+
/**
|
|
25126
|
+
* Maximum number of workflow subagents that may run concurrently.
|
|
25127
|
+
*/
|
|
25128
|
+
maxConcurrentSubagents?: number | null;
|
|
25129
|
+
/**
|
|
25130
|
+
* Maximum total number of workflow subagents that may be admitted.
|
|
25131
|
+
*/
|
|
25132
|
+
maxTotalSubagents?: number | null;
|
|
25133
|
+
/**
|
|
25134
|
+
* Maximum accumulated active-execution time in seconds. Active execution includes the entire extension body, subprocess waits, queued-agent waits, and sleeps; time between resumed attempts is not counted.
|
|
25135
|
+
*/
|
|
25136
|
+
timeoutSeconds?: number | null;
|
|
25137
|
+
/**
|
|
25138
|
+
* Maximum AI credits consumed by workflow subagents and their descendants. The post-paid ceiling is soft: parallel turns can settle beyond it before the run stops.
|
|
25139
|
+
*/
|
|
25140
|
+
maxAiCredits?: number | null;
|
|
25141
|
+
}
|
|
25142
|
+
/**
|
|
25143
|
+
* Resolved persisted workflow identity and resumed run envelope.
|
|
25144
|
+
*
|
|
25145
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25146
|
+
* via the `definition` "WorkflowResumeResult".
|
|
25147
|
+
*/
|
|
25148
|
+
/** @experimental */
|
|
25149
|
+
export interface WorkflowResumeResult {
|
|
25150
|
+
/**
|
|
25151
|
+
* Persisted workflow name resolved for the resumed run.
|
|
25152
|
+
*/
|
|
25153
|
+
workflowName: string;
|
|
25154
|
+
run: WorkflowRunResult;
|
|
25155
|
+
}
|
|
25156
|
+
/**
|
|
25157
|
+
* Complete current or terminal workflow run envelope.
|
|
25158
|
+
*
|
|
25159
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25160
|
+
* via the `definition` "WorkflowRunResult".
|
|
25161
|
+
*/
|
|
25162
|
+
/** @experimental */
|
|
25163
|
+
export interface WorkflowRunResult {
|
|
25164
|
+
/**
|
|
25165
|
+
* Workflow run identifier.
|
|
25166
|
+
*/
|
|
25167
|
+
runId: string;
|
|
25168
|
+
/**
|
|
25169
|
+
* One-based execution attempt represented by this envelope. Absent before the first attempt starts or when returned by an older runtime.
|
|
25170
|
+
*/
|
|
25171
|
+
attempt?: number;
|
|
25172
|
+
status: WorkflowRunStatus;
|
|
25173
|
+
/**
|
|
25174
|
+
* Completed workflow result.
|
|
25175
|
+
*/
|
|
25176
|
+
result?: JsonValue;
|
|
25177
|
+
/**
|
|
25178
|
+
* Error message for an errored run.
|
|
25179
|
+
*/
|
|
25180
|
+
error?: string;
|
|
25181
|
+
failure?: WorkflowRunFailure;
|
|
25182
|
+
/**
|
|
25183
|
+
* Reason for a halted or cancelled run.
|
|
25184
|
+
*/
|
|
25185
|
+
reason?: string;
|
|
25186
|
+
/**
|
|
25187
|
+
* Partial journal and progress snapshot for a halted, cancelled, or errored run.
|
|
25188
|
+
*/
|
|
25189
|
+
snapshot?: JsonValue;
|
|
25190
|
+
pauseInfo?: WorkflowPauseInfo;
|
|
25191
|
+
}
|
|
25192
|
+
/**
|
|
25193
|
+
* Full workflow run observability detail.
|
|
25194
|
+
*
|
|
25195
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25196
|
+
* via the `definition` "WorkflowRunDetail".
|
|
25197
|
+
*/
|
|
25198
|
+
/** @experimental */
|
|
25199
|
+
export interface WorkflowRunDetail {
|
|
25200
|
+
/**
|
|
25201
|
+
* Workflow run identifier.
|
|
25202
|
+
*/
|
|
25203
|
+
runId: string;
|
|
25204
|
+
/**
|
|
25205
|
+
* Registered workflow name.
|
|
25206
|
+
*/
|
|
25207
|
+
workflowName: string;
|
|
25208
|
+
/**
|
|
25209
|
+
* Human-readable workflow description.
|
|
25210
|
+
*/
|
|
25211
|
+
description: string;
|
|
25212
|
+
status: WorkflowRunStatus;
|
|
25213
|
+
/**
|
|
25214
|
+
* Monotonic durable run revision.
|
|
25215
|
+
*/
|
|
25216
|
+
revision: number;
|
|
25217
|
+
/**
|
|
25218
|
+
* Epoch milliseconds when the run was created.
|
|
25219
|
+
*/
|
|
25220
|
+
createdAt: number;
|
|
25221
|
+
/**
|
|
25222
|
+
* Epoch milliseconds when execution first started, or null before start.
|
|
25223
|
+
*/
|
|
25224
|
+
startedAt: number | null;
|
|
25225
|
+
/**
|
|
25226
|
+
* Epoch milliseconds when the durable run was last updated.
|
|
25227
|
+
*/
|
|
25228
|
+
updatedAt: number;
|
|
25229
|
+
/**
|
|
25230
|
+
* Epoch milliseconds when the run completed, or null while nonterminal.
|
|
25231
|
+
*/
|
|
25232
|
+
completedAt: number | null;
|
|
25233
|
+
/**
|
|
25234
|
+
* Current phase identity, or null before any phase is entered.
|
|
25235
|
+
*/
|
|
25236
|
+
currentPhase: WorkflowCurrentPhase | null;
|
|
25237
|
+
/**
|
|
25238
|
+
* Number of phases declared by the workflow.
|
|
25239
|
+
*/
|
|
25240
|
+
declaredPhaseCount: number;
|
|
25241
|
+
/**
|
|
25242
|
+
* Number of direct workflow agents currently live.
|
|
25243
|
+
*/
|
|
25244
|
+
liveAgentCount: number;
|
|
25245
|
+
/**
|
|
25246
|
+
* Total direct workflow agents spawned across all attempts.
|
|
25247
|
+
*/
|
|
25248
|
+
totalSpawnedAgentCount: number;
|
|
25249
|
+
consumed: WorkflowRunConsumed;
|
|
25250
|
+
declaredLimits: WorkflowDeclaredLimits;
|
|
25251
|
+
/**
|
|
25252
|
+
* Approved effective resource ceilings, or null until approved.
|
|
25253
|
+
*/
|
|
25254
|
+
approved: WorkflowDeclaredLimits | null;
|
|
25255
|
+
/**
|
|
25256
|
+
* Epoch milliseconds when this live-overlay snapshot was observed.
|
|
25257
|
+
*/
|
|
25258
|
+
observedAt: number;
|
|
25259
|
+
/**
|
|
25260
|
+
* Epoch milliseconds when the current active segment started, or null while inactive.
|
|
25261
|
+
*/
|
|
25262
|
+
activeSegmentStartedAt: number | null;
|
|
25263
|
+
/**
|
|
25264
|
+
* Terminal run outcome, or null while nonterminal.
|
|
25265
|
+
*/
|
|
25266
|
+
terminal: WorkflowRunTerminal | null;
|
|
25267
|
+
/**
|
|
25268
|
+
* Whether the durable run state currently passes runtime resume eligibility checks.
|
|
25269
|
+
*/
|
|
25270
|
+
canResume: boolean;
|
|
25271
|
+
/**
|
|
25272
|
+
* Lifecycle and timing observations for each workflow phase.
|
|
25273
|
+
*/
|
|
25274
|
+
phases: WorkflowPhaseObservation[];
|
|
25275
|
+
/**
|
|
25276
|
+
* Durable identities and live statuses for direct workflow agents.
|
|
25277
|
+
*/
|
|
25278
|
+
agents: WorkflowAgentSummary[];
|
|
25279
|
+
progress: WorkflowProgressPage;
|
|
25280
|
+
}
|
|
25281
|
+
/**
|
|
25282
|
+
* Options controlling workflow invocation.
|
|
25283
|
+
*
|
|
25284
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25285
|
+
* via the `definition` "WorkflowRunOptions".
|
|
25286
|
+
*/
|
|
25287
|
+
/** @experimental */
|
|
25288
|
+
export interface WorkflowRunOptions {
|
|
25289
|
+
limits?: WorkflowRunLimits;
|
|
25290
|
+
/**
|
|
25291
|
+
* Whether to notify the originating session when the workflow completes.
|
|
25292
|
+
*/
|
|
25293
|
+
notifyOnComplete?: boolean;
|
|
25294
|
+
/**
|
|
25295
|
+
* Whether to emit workflow phase names to the session transcript.
|
|
25296
|
+
*/
|
|
25297
|
+
logPhaseNames?: boolean;
|
|
25298
|
+
/**
|
|
25299
|
+
* Run identifier whose journal and progress should seed this resumed run.
|
|
25300
|
+
*/
|
|
25301
|
+
resumeFromRunId?: string;
|
|
25302
|
+
}
|
|
25303
|
+
/**
|
|
25304
|
+
* Parameters for invoking a registered workflow.
|
|
25305
|
+
*
|
|
25306
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25307
|
+
* via the `definition` "WorkflowRunRequest".
|
|
25308
|
+
*/
|
|
25309
|
+
/** @experimental */
|
|
25310
|
+
export interface WorkflowRunRequest {
|
|
25311
|
+
/**
|
|
25312
|
+
* Registered workflow name.
|
|
25313
|
+
*/
|
|
25314
|
+
name: string;
|
|
25315
|
+
/**
|
|
25316
|
+
* Workflow input value.
|
|
25317
|
+
*/
|
|
25318
|
+
args: JsonValue;
|
|
25319
|
+
options?: WorkflowRunOptions;
|
|
25320
|
+
}
|
|
25321
|
+
/**
|
|
25322
|
+
* A single changed file and its unified diff.
|
|
25323
|
+
*
|
|
25324
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25325
|
+
* via the `definition` "WorkspaceDiffFileChange".
|
|
25326
|
+
*/
|
|
25327
|
+
/** @experimental */
|
|
25328
|
+
export interface WorkspaceDiffFileChange {
|
|
25329
|
+
/**
|
|
25330
|
+
* Path to the changed file, relative to the workspace root when the file lives under it. A file changed outside the workspace root keeps a `../`-relative path, or an absolute path when no relative path exists (for example a different Windows drive).
|
|
25331
|
+
*/
|
|
25332
|
+
path: string;
|
|
25333
|
+
/**
|
|
25334
|
+
* Unified diff content for the file. Empty when the diff was truncated.
|
|
25335
|
+
*/
|
|
25336
|
+
diff: string;
|
|
25337
|
+
changeType: WorkspaceDiffFileChangeType;
|
|
25338
|
+
/**
|
|
25339
|
+
* Original file path for renamed files.
|
|
25340
|
+
*/
|
|
25341
|
+
oldPath?: string;
|
|
25342
|
+
/**
|
|
25343
|
+
* Whether the diff content was omitted because it exceeded the per-file size limit.
|
|
25344
|
+
*/
|
|
25345
|
+
isTruncated?: boolean;
|
|
25346
|
+
}
|
|
25347
|
+
/**
|
|
25348
|
+
* Workspace diff result for the requested mode.
|
|
25349
|
+
*
|
|
25350
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25351
|
+
* via the `definition` "WorkspaceDiffResult".
|
|
25352
|
+
*/
|
|
25353
|
+
/** @experimental */
|
|
25354
|
+
export interface WorkspaceDiffResult {
|
|
25355
|
+
requestedMode: WorkspaceDiffMode;
|
|
25356
|
+
mode: WorkspaceDiffMode;
|
|
25357
|
+
/**
|
|
25358
|
+
* Changed files and their unified diffs.
|
|
25359
|
+
*/
|
|
25360
|
+
changes: WorkspaceDiffFileChange[];
|
|
25361
|
+
/**
|
|
25362
|
+
* Default branch used for a branch diff, when branch mode was requested.
|
|
25363
|
+
*/
|
|
25364
|
+
baseBranch?: string;
|
|
25365
|
+
/**
|
|
25366
|
+
* Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable.
|
|
25367
|
+
*/
|
|
25368
|
+
isFallback: boolean;
|
|
25369
|
+
unavailableReason?: HistoryRewindUnavailableReason;
|
|
25370
|
+
}
|
|
25371
|
+
/**
|
|
25372
|
+
* Compaction summary checkpoint to persist.
|
|
25373
|
+
*
|
|
25374
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25375
|
+
* via the `definition` "WorkspacesAddSummaryRequest".
|
|
25376
|
+
*/
|
|
25377
|
+
/** @experimental */
|
|
25378
|
+
export interface WorkspacesAddSummaryRequest {
|
|
25379
|
+
/**
|
|
25380
|
+
* Summary title shown in checkpoint listings.
|
|
25381
|
+
*/
|
|
25382
|
+
title: string;
|
|
25383
|
+
/**
|
|
25384
|
+
* Markdown summary content to persist.
|
|
25385
|
+
*/
|
|
25386
|
+
content: string;
|
|
25387
|
+
}
|
|
25388
|
+
/**
|
|
25389
|
+
* Persisted summary metadata and refreshed workspace metadata.
|
|
25390
|
+
*
|
|
25391
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25392
|
+
* via the `definition` "WorkspacesAddSummaryResult".
|
|
25393
|
+
*/
|
|
25394
|
+
/** @experimental */
|
|
25395
|
+
export interface WorkspacesAddSummaryResult {
|
|
25396
|
+
/**
|
|
25397
|
+
* Metadata for the persisted summary.
|
|
25398
|
+
*/
|
|
25399
|
+
summary?: {};
|
|
25400
|
+
/**
|
|
25401
|
+
* Refreshed metadata for the containing workspace.
|
|
25402
|
+
*/
|
|
25403
|
+
workspace?: {};
|
|
25404
|
+
[k: string]: unknown | undefined;
|
|
25405
|
+
}
|
|
25406
|
+
/**
|
|
25407
|
+
* Whether the autopilot objective file exists.
|
|
25408
|
+
*
|
|
25409
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25410
|
+
* via the `definition` "WorkspacesAutopilotObjectiveExistsResult".
|
|
25411
|
+
*/
|
|
25412
|
+
/** @experimental */
|
|
25413
|
+
export interface WorkspacesAutopilotObjectiveExistsResult {
|
|
25414
|
+
/**
|
|
25415
|
+
* True when the objective file exists.
|
|
25416
|
+
*/
|
|
25417
|
+
exists: boolean;
|
|
25418
|
+
}
|
|
25419
|
+
/**
|
|
25420
|
+
* Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename.
|
|
25421
|
+
*
|
|
25422
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25423
|
+
* via the `definition` "WorkspacesCheckpoints".
|
|
25424
|
+
*/
|
|
25425
|
+
/** @experimental */
|
|
25426
|
+
export interface WorkspacesCheckpoints {
|
|
25427
|
+
/**
|
|
25428
|
+
* Checkpoint number assigned by the workspace manager
|
|
23034
25429
|
*/
|
|
23035
25430
|
number: number;
|
|
23036
25431
|
/**
|
|
@@ -23042,6 +25437,23 @@ export interface WorkspacesCheckpoints {
|
|
|
23042
25437
|
*/
|
|
23043
25438
|
filename: string;
|
|
23044
25439
|
}
|
|
25440
|
+
/**
|
|
25441
|
+
* Directory to create within the session workspace files directory.
|
|
25442
|
+
*
|
|
25443
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25444
|
+
* via the `definition` "WorkspacesCreateDirectoryRequest".
|
|
25445
|
+
*/
|
|
25446
|
+
/** @experimental */
|
|
25447
|
+
export interface WorkspacesCreateDirectoryRequest {
|
|
25448
|
+
/**
|
|
25449
|
+
* Slash-separated relative path within the workspace files directory
|
|
25450
|
+
*/
|
|
25451
|
+
path: string;
|
|
25452
|
+
/**
|
|
25453
|
+
* Whether to create missing parent directories. Defaults to false.
|
|
25454
|
+
*/
|
|
25455
|
+
recursive?: boolean;
|
|
25456
|
+
}
|
|
23045
25457
|
/**
|
|
23046
25458
|
* Relative path and UTF-8 content for the workspace file to create or overwrite.
|
|
23047
25459
|
*
|
|
@@ -23051,7 +25463,7 @@ export interface WorkspacesCheckpoints {
|
|
|
23051
25463
|
/** @experimental */
|
|
23052
25464
|
export interface WorkspacesCreateFileRequest {
|
|
23053
25465
|
/**
|
|
23054
|
-
*
|
|
25466
|
+
* Slash-separated relative path within the workspace files directory
|
|
23055
25467
|
*/
|
|
23056
25468
|
path: string;
|
|
23057
25469
|
/**
|
|
@@ -23204,7 +25616,7 @@ export interface WorkspacesListCheckpointsResult {
|
|
|
23204
25616
|
/** @experimental */
|
|
23205
25617
|
export interface WorkspacesListFilesResult {
|
|
23206
25618
|
/**
|
|
23207
|
-
*
|
|
25619
|
+
* Slash-separated relative file paths in the workspace files directory
|
|
23208
25620
|
*/
|
|
23209
25621
|
files: string[];
|
|
23210
25622
|
}
|
|
@@ -23256,7 +25668,7 @@ export interface WorkspacesReadCheckpointResult {
|
|
|
23256
25668
|
/** @experimental */
|
|
23257
25669
|
export interface WorkspacesReadFileRequest {
|
|
23258
25670
|
/**
|
|
23259
|
-
*
|
|
25671
|
+
* Slash-separated relative path within the workspace files directory
|
|
23260
25672
|
*/
|
|
23261
25673
|
path: string;
|
|
23262
25674
|
}
|
|
@@ -23273,6 +25685,44 @@ export interface WorkspacesReadFileResult {
|
|
|
23273
25685
|
*/
|
|
23274
25686
|
content: string;
|
|
23275
25687
|
}
|
|
25688
|
+
/**
|
|
25689
|
+
* File or directory to remove from the session workspace files directory.
|
|
25690
|
+
*
|
|
25691
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25692
|
+
* via the `definition` "WorkspacesRemovePathRequest".
|
|
25693
|
+
*/
|
|
25694
|
+
/** @experimental */
|
|
25695
|
+
export interface WorkspacesRemovePathRequest {
|
|
25696
|
+
/**
|
|
25697
|
+
* Slash-separated relative path within the workspace files directory
|
|
25698
|
+
*/
|
|
25699
|
+
path: string;
|
|
25700
|
+
/**
|
|
25701
|
+
* Whether to remove directory contents recursively. Defaults to false.
|
|
25702
|
+
*/
|
|
25703
|
+
recursive?: boolean;
|
|
25704
|
+
/**
|
|
25705
|
+
* Whether a missing path should be treated as success. Defaults to false.
|
|
25706
|
+
*/
|
|
25707
|
+
force?: boolean;
|
|
25708
|
+
}
|
|
25709
|
+
/**
|
|
25710
|
+
* Source and destination paths for a rename within the session workspace files directory.
|
|
25711
|
+
*
|
|
25712
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25713
|
+
* via the `definition` "WorkspacesRenamePathRequest".
|
|
25714
|
+
*/
|
|
25715
|
+
/** @experimental */
|
|
25716
|
+
export interface WorkspacesRenamePathRequest {
|
|
25717
|
+
/**
|
|
25718
|
+
* Slash-separated source path relative to the workspace files directory
|
|
25719
|
+
*/
|
|
25720
|
+
source: string;
|
|
25721
|
+
/**
|
|
25722
|
+
* Slash-separated destination path relative to the workspace files directory
|
|
25723
|
+
*/
|
|
25724
|
+
destination: string;
|
|
25725
|
+
}
|
|
23276
25726
|
/**
|
|
23277
25727
|
* Pasted content to save as a UTF-8 file in the session workspace.
|
|
23278
25728
|
*
|
|
@@ -23312,6 +25762,48 @@ export interface WorkspacesSaveLargePasteResult {
|
|
|
23312
25762
|
sizeBytes: number;
|
|
23313
25763
|
} | null;
|
|
23314
25764
|
}
|
|
25765
|
+
/**
|
|
25766
|
+
* Relative path of the workspace file or directory to inspect.
|
|
25767
|
+
*
|
|
25768
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25769
|
+
* via the `definition` "WorkspacesStatFileRequest".
|
|
25770
|
+
*/
|
|
25771
|
+
/** @experimental */
|
|
25772
|
+
export interface WorkspacesStatFileRequest {
|
|
25773
|
+
/**
|
|
25774
|
+
* Slash-separated relative path within the workspace files directory
|
|
25775
|
+
*/
|
|
25776
|
+
path: string;
|
|
25777
|
+
}
|
|
25778
|
+
/**
|
|
25779
|
+
* Filesystem metadata for a path in the session workspace files directory.
|
|
25780
|
+
*
|
|
25781
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25782
|
+
* via the `definition` "WorkspacesStatFileResult".
|
|
25783
|
+
*/
|
|
25784
|
+
/** @experimental */
|
|
25785
|
+
export interface WorkspacesStatFileResult {
|
|
25786
|
+
/**
|
|
25787
|
+
* Whether the path identifies a regular file
|
|
25788
|
+
*/
|
|
25789
|
+
isFile: boolean;
|
|
25790
|
+
/**
|
|
25791
|
+
* Whether the path identifies a directory
|
|
25792
|
+
*/
|
|
25793
|
+
isDirectory: boolean;
|
|
25794
|
+
/**
|
|
25795
|
+
* Size in bytes
|
|
25796
|
+
*/
|
|
25797
|
+
size: number;
|
|
25798
|
+
/**
|
|
25799
|
+
* Last modification time in Unix epoch milliseconds
|
|
25800
|
+
*/
|
|
25801
|
+
mtimeMs: number;
|
|
25802
|
+
/**
|
|
25803
|
+
* Creation time in Unix epoch milliseconds
|
|
25804
|
+
*/
|
|
25805
|
+
birthtimeMs: number;
|
|
25806
|
+
}
|
|
23315
25807
|
/**
|
|
23316
25808
|
* Rollback point for local workspace summaries.
|
|
23317
25809
|
*
|
|
@@ -23373,6 +25865,10 @@ export interface SessionFactoryPauseAtCheckpointResult {
|
|
|
23373
25865
|
action: FactoryPauseCheckpointAction;
|
|
23374
25866
|
}
|
|
23375
25867
|
/** @experimental */
|
|
25868
|
+
export interface SessionWorkflowPauseAtCheckpointResult {
|
|
25869
|
+
action: WorkflowPauseCheckpointAction;
|
|
25870
|
+
}
|
|
25871
|
+
/** @experimental */
|
|
23376
25872
|
export interface SessionModelListRequest {
|
|
23377
25873
|
/**
|
|
23378
25874
|
* If true, bypasses the per-session model list cache and re-fetches from CAPI.
|
|
@@ -23401,6 +25897,13 @@ export interface SessionMcpAppsCallToolResult {
|
|
|
23401
25897
|
[k: string]: JsonValue | undefined;
|
|
23402
25898
|
}
|
|
23403
25899
|
/** @experimental */
|
|
25900
|
+
export interface SessionPluginsMarketplacesRefreshRequest {
|
|
25901
|
+
/**
|
|
25902
|
+
* Marketplace name to refresh. When omitted, every registered marketplace is refreshed.
|
|
25903
|
+
*/
|
|
25904
|
+
name?: string;
|
|
25905
|
+
}
|
|
25906
|
+
/** @experimental */
|
|
23404
25907
|
export interface SessionPluginsReloadRequest {
|
|
23405
25908
|
/**
|
|
23406
25909
|
* Reload MCP server connections after refreshing plugins. Defaults to true.
|
|
@@ -23696,6 +26199,14 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
23696
26199
|
* @returns Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success.
|
|
23697
26200
|
*/
|
|
23698
26201
|
search: (params: CatalogSearchRequest) => Promise<CatalogSearchResult>;
|
|
26202
|
+
/**
|
|
26203
|
+
* Terminates one retained catalog selection group. A selected outcome returns the native host a fresh single-use candidate handle plus the original searchId for a later explicit mcp.planInstall call; non-selected outcomes release the group without producing a planning input. Candidate state, cards, URLs, credentials and private identifiers remain inside the runtime. The model-facing catalog_select tool projects the result separately and never exposes the candidate handle or searchId.
|
|
26204
|
+
*
|
|
26205
|
+
* @param params Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.
|
|
26206
|
+
*
|
|
26207
|
+
* @returns Typed outcome of catalog.select. Only the selected host result carries a fresh candidate handle; the model-facing projection removes both that handle and searchId.
|
|
26208
|
+
*/
|
|
26209
|
+
select: (params: CatalogSelectionRequest) => Promise<CatalogSelectionResult>;
|
|
23699
26210
|
};
|
|
23700
26211
|
/** @experimental */
|
|
23701
26212
|
plugins: {
|
|
@@ -23926,7 +26437,7 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
23926
26437
|
/**
|
|
23927
26438
|
* Registers an SDK client as the session filesystem provider.
|
|
23928
26439
|
*
|
|
23929
|
-
* @param params Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider.
|
|
26440
|
+
* @param params Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. A registered provider is authoritative for path interpretation and filesystem facts used by workspace permission validation. Paths are interpreted lexically; home-relative paths (`~` and `~/...`) and Windows drive-relative paths such as `C:foo` are unsupported. Until provider-side canonicalization is supported, providers must not expose symlinks inside allowed roots that escape those roots.
|
|
23930
26441
|
*
|
|
23931
26442
|
* @returns Indicates whether the calling client was registered as the session filesystem provider.
|
|
23932
26443
|
*/
|
|
@@ -24269,11 +26780,11 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
24269
26780
|
/** @experimental */
|
|
24270
26781
|
debug: {
|
|
24271
26782
|
/**
|
|
24272
|
-
* Collects a
|
|
26783
|
+
* Collects a session debug log bundle into a local archive or staging directory. Logs are redacted by default; redaction can be configured per caller-provided diagnostic entry. The runtime includes session-owned logs by default and accepts caller-provided diagnostic entries so host applications can add their own files without changing this API shape.
|
|
24273
26784
|
*
|
|
24274
|
-
* @param params Options for collecting a
|
|
26785
|
+
* @param params Options for collecting a session debug bundle with configurable redaction.
|
|
24275
26786
|
*
|
|
24276
|
-
* @returns Result of collecting a
|
|
26787
|
+
* @returns Result of collecting a session debug bundle.
|
|
24277
26788
|
*/
|
|
24278
26789
|
collectLogs: (params: DebugCollectLogsRequest) => Promise<DebugCollectLogsResult>;
|
|
24279
26790
|
};
|
|
@@ -24420,6 +26931,108 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
24420
26931
|
};
|
|
24421
26932
|
};
|
|
24422
26933
|
/** @experimental */
|
|
26934
|
+
workflow: {
|
|
26935
|
+
/**
|
|
26936
|
+
* Runs a registered dynamic workflow by name at the top level.
|
|
26937
|
+
*
|
|
26938
|
+
* @param params Parameters for invoking a registered workflow.
|
|
26939
|
+
*
|
|
26940
|
+
* @returns Complete current or terminal workflow run envelope.
|
|
26941
|
+
*/
|
|
26942
|
+
run: (params: WorkflowRunRequest) => Promise<WorkflowRunResult>;
|
|
26943
|
+
/**
|
|
26944
|
+
* Resumes a dynamic workflow run using its persisted name, arguments, journal, and accounting.
|
|
26945
|
+
*
|
|
26946
|
+
* @param params Parameters for resuming a workflow run from its persisted identity.
|
|
26947
|
+
*
|
|
26948
|
+
* @returns Resolved persisted workflow identity and resumed run envelope.
|
|
26949
|
+
*/
|
|
26950
|
+
resume: (params: WorkflowResumeRequest) => Promise<WorkflowResumeResult>;
|
|
26951
|
+
/**
|
|
26952
|
+
* Gets the current or settled envelope for a dynamic workflow run.
|
|
26953
|
+
*
|
|
26954
|
+
* @param params Parameters for retrieving a workflow run.
|
|
26955
|
+
*
|
|
26956
|
+
* @returns Complete current or terminal workflow run envelope.
|
|
26957
|
+
*/
|
|
26958
|
+
getRun: (params: WorkflowGetRunRequest) => Promise<WorkflowRunResult>;
|
|
26959
|
+
/**
|
|
26960
|
+
* Lists durable dynamic workflow runs for this session in creation order.
|
|
26961
|
+
*
|
|
26962
|
+
* @param params Parameters for paging workflow runs.
|
|
26963
|
+
*
|
|
26964
|
+
* @returns A page of workflow runs in durable creation order.
|
|
26965
|
+
*/
|
|
26966
|
+
listRuns: (params: WorkflowListRunsRequest) => Promise<WorkflowListRunsResult>;
|
|
26967
|
+
/**
|
|
26968
|
+
* Gets durable and live observability detail for one dynamic workflow run.
|
|
26969
|
+
*
|
|
26970
|
+
* @param params Parameters for retrieving a workflow run.
|
|
26971
|
+
*
|
|
26972
|
+
* @returns Full workflow run observability detail.
|
|
26973
|
+
*/
|
|
26974
|
+
getRunDetail: (params: WorkflowGetRunRequest) => Promise<WorkflowRunDetail>;
|
|
26975
|
+
/**
|
|
26976
|
+
* Pages durable progress for one dynamic workflow run.
|
|
26977
|
+
*
|
|
26978
|
+
* @param params Parameters for paging workflow progress.
|
|
26979
|
+
*
|
|
26980
|
+
* @returns A bidirectional page of workflow progress.
|
|
26981
|
+
*/
|
|
26982
|
+
getRunProgress: (params: WorkflowGetRunProgressRequest) => Promise<WorkflowProgressPage>;
|
|
26983
|
+
/**
|
|
26984
|
+
* Requests cancellation of a dynamic workflow run and returns its run envelope.
|
|
26985
|
+
*
|
|
26986
|
+
* @param params Parameters for cancelling a workflow run.
|
|
26987
|
+
*
|
|
26988
|
+
* @returns Complete current or terminal workflow run envelope.
|
|
26989
|
+
*/
|
|
26990
|
+
cancel: (params: WorkflowCancelRequest) => Promise<WorkflowRunResult>;
|
|
26991
|
+
/**
|
|
26992
|
+
* Pauses a running dynamic workflow and returns its settled run envelope.
|
|
26993
|
+
*
|
|
26994
|
+
* @param params Parameters for pausing a running workflow.
|
|
26995
|
+
*
|
|
26996
|
+
* @returns Complete current or terminal workflow run envelope.
|
|
26997
|
+
*/
|
|
26998
|
+
pause: (params: WorkflowPauseRequest) => Promise<WorkflowRunResult>;
|
|
26999
|
+
/**
|
|
27000
|
+
* Records a batch of ordered dynamic workflow progress lines.
|
|
27001
|
+
*
|
|
27002
|
+
* @param params Parameters for recording workflow progress.
|
|
27003
|
+
*
|
|
27004
|
+
* @returns Acknowledgement that a workflow request was accepted.
|
|
27005
|
+
*/
|
|
27006
|
+
log: (params: WorkflowLogRequest) => Promise<WorkflowAckResult>;
|
|
27007
|
+
/**
|
|
27008
|
+
* Runs one dynamic-workflow-scoped subagent and returns its result.
|
|
27009
|
+
*
|
|
27010
|
+
* @param params Parameters for one workflow-scoped subagent call.
|
|
27011
|
+
*
|
|
27012
|
+
* @returns Result of one workflow-scoped subagent call.
|
|
27013
|
+
*/
|
|
27014
|
+
agent: (params: WorkflowAgentRequest) => Promise<WorkflowAgentResult>;
|
|
27015
|
+
/** @experimental */
|
|
27016
|
+
journal: {
|
|
27017
|
+
/**
|
|
27018
|
+
* Reads a memoized dynamic workflow journal entry.
|
|
27019
|
+
*
|
|
27020
|
+
* @param params Parameters for reading a workflow journal entry.
|
|
27021
|
+
*
|
|
27022
|
+
* @returns Result of reading a workflow journal entry.
|
|
27023
|
+
*/
|
|
27024
|
+
get: (params: WorkflowJournalGetRequest) => Promise<WorkflowJournalGetResult>;
|
|
27025
|
+
/**
|
|
27026
|
+
* Stores a memoized dynamic workflow journal entry.
|
|
27027
|
+
*
|
|
27028
|
+
* @param params Parameters for storing a workflow journal entry.
|
|
27029
|
+
*
|
|
27030
|
+
* @returns Acknowledgement that a workflow request was accepted.
|
|
27031
|
+
*/
|
|
27032
|
+
put: (params: WorkflowJournalPutRequest) => Promise<WorkflowAckResult>;
|
|
27033
|
+
};
|
|
27034
|
+
};
|
|
27035
|
+
/** @experimental */
|
|
24423
27036
|
model: {
|
|
24424
27037
|
/**
|
|
24425
27038
|
* Gets the session's authoritative model snapshot, including the committed Auto preference and any newer unclaimed Auto preference waiting for a future user turn.
|
|
@@ -24583,6 +27196,32 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
24583
27196
|
* @param params Relative path and UTF-8 content for the workspace file to create or overwrite.
|
|
24584
27197
|
*/
|
|
24585
27198
|
createFile: (params: WorkspacesCreateFileRequest) => Promise<void>;
|
|
27199
|
+
/**
|
|
27200
|
+
* Returns metadata for a file or directory in the session workspace files directory.
|
|
27201
|
+
*
|
|
27202
|
+
* @param params Relative path of the workspace file or directory to inspect.
|
|
27203
|
+
*
|
|
27204
|
+
* @returns Filesystem metadata for a path in the session workspace files directory.
|
|
27205
|
+
*/
|
|
27206
|
+
statFile: (params: WorkspacesStatFileRequest) => Promise<WorkspacesStatFileResult>;
|
|
27207
|
+
/**
|
|
27208
|
+
* Creates a directory in the session workspace files directory.
|
|
27209
|
+
*
|
|
27210
|
+
* @param params Directory to create within the session workspace files directory.
|
|
27211
|
+
*/
|
|
27212
|
+
createDirectory: (params: WorkspacesCreateDirectoryRequest) => Promise<void>;
|
|
27213
|
+
/**
|
|
27214
|
+
* Removes a file or directory from the session workspace files directory.
|
|
27215
|
+
*
|
|
27216
|
+
* @param params File or directory to remove from the session workspace files directory.
|
|
27217
|
+
*/
|
|
27218
|
+
removePath: (params: WorkspacesRemovePathRequest) => Promise<void>;
|
|
27219
|
+
/**
|
|
27220
|
+
* Renames a file or directory within the session workspace files directory.
|
|
27221
|
+
*
|
|
27222
|
+
* @param params Source and destination paths for a rename within the session workspace files directory.
|
|
27223
|
+
*/
|
|
27224
|
+
renamePath: (params: WorkspacesRenamePathRequest) => Promise<void>;
|
|
24586
27225
|
/**
|
|
24587
27226
|
* Lists workspace checkpoints in chronological order.
|
|
24588
27227
|
*
|
|
@@ -25099,13 +27738,168 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25099
27738
|
};
|
|
25100
27739
|
};
|
|
25101
27740
|
/** @experimental */
|
|
27741
|
+
connectors: {
|
|
27742
|
+
/**
|
|
27743
|
+
* Returns feature availability and bounded polling limits for the EXPERIMENTAL session connector API. This method never performs a Connector service request.
|
|
27744
|
+
*
|
|
27745
|
+
* @returns Feature detection and hard polling limits for the EXPERIMENTAL session connector API.
|
|
27746
|
+
*/
|
|
27747
|
+
getCapabilities: () => Promise<ConnectorCapabilities>;
|
|
27748
|
+
/**
|
|
27749
|
+
* Returns authoritative session Connector state from current availability, pinned account selection, cached catalog, and live MCP projection without performing a Connector service request.
|
|
27750
|
+
*
|
|
27751
|
+
* @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
|
|
27752
|
+
*/
|
|
27753
|
+
getStatus: () => Promise<ConnectorStatus>;
|
|
27754
|
+
/**
|
|
27755
|
+
* Returns the cached Connector catalog for the pinned opaque account selection, fetching it only when this session has no cached catalog.
|
|
27756
|
+
*
|
|
27757
|
+
* @param params Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
|
|
27758
|
+
*
|
|
27759
|
+
* @returns Validated Connector catalog snapshot cached by the session.
|
|
27760
|
+
*/
|
|
27761
|
+
list: (params: ConnectorAccountRequest) => Promise<ConnectorCatalogResult>;
|
|
27762
|
+
/**
|
|
27763
|
+
* Refreshes and validates the Connector catalog for the pinned opaque account selection.
|
|
27764
|
+
*
|
|
27765
|
+
* @param params Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
|
|
27766
|
+
*
|
|
27767
|
+
* @returns Validated Connector catalog snapshot cached by the session.
|
|
27768
|
+
*/
|
|
27769
|
+
refresh: (params: ConnectorAccountRequest) => Promise<ConnectorCatalogResult>;
|
|
27770
|
+
/**
|
|
27771
|
+
* Initiates an idempotent Connector connection request without opening a browser. Returns connected when the service is immediately authoritative, consent_required with a validated URL, or pending with an opaque continuation ID.
|
|
27772
|
+
*
|
|
27773
|
+
* @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
|
|
27774
|
+
*
|
|
27775
|
+
* @returns Typed result of initiating or continuing a Connector connection.
|
|
27776
|
+
*/
|
|
27777
|
+
connect: (params: ConnectorConnectRequest) => Promise<ConnectorConnectResult>;
|
|
27778
|
+
/**
|
|
27779
|
+
* Re-initiates an idempotent Connector connection request without browser or UI effects, with the same typed outcomes as connect.
|
|
27780
|
+
*
|
|
27781
|
+
* @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
|
|
27782
|
+
*
|
|
27783
|
+
* @returns Typed result of initiating or continuing a Connector connection.
|
|
27784
|
+
*/
|
|
27785
|
+
reconnect: (params: ConnectorConnectRequest) => Promise<ConnectorConnectResult>;
|
|
27786
|
+
/**
|
|
27787
|
+
* Continues a pending Connector connection with caller-supplied attempt, interval, and deadline bounds. The runtime never opens the returned consent URL.
|
|
27788
|
+
*
|
|
27789
|
+
* @param params Explicitly bounded continuation of a pending Connector connection.
|
|
27790
|
+
*
|
|
27791
|
+
* @returns Typed result of initiating or continuing a Connector connection.
|
|
27792
|
+
*/
|
|
27793
|
+
continueConnection: (params: ConnectorContinueRequest) => Promise<ConnectorConnectResult>;
|
|
27794
|
+
/**
|
|
27795
|
+
* Disconnects one Connector for the pinned opaque account selection, refreshes the authoritative catalog, and removes its session-owned MCP projection.
|
|
27796
|
+
*
|
|
27797
|
+
* @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
|
|
27798
|
+
*
|
|
27799
|
+
* @returns Authoritative result after disconnect and MCP reconciliation.
|
|
27800
|
+
*/
|
|
27801
|
+
disconnect: (params: ConnectorConnectRequest) => Promise<ConnectorDisconnectResult>;
|
|
27802
|
+
/**
|
|
27803
|
+
* Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.
|
|
27804
|
+
*
|
|
27805
|
+
* @param params Requests authoritative Connector-to-MCP reconciliation for the pinned account.
|
|
27806
|
+
*
|
|
27807
|
+
* @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
|
|
27808
|
+
*/
|
|
27809
|
+
reconcile: (params: ConnectorReconcileRequest) => Promise<ConnectorStatus>;
|
|
27810
|
+
};
|
|
27811
|
+
/** @experimental */
|
|
27812
|
+
managedSettings: {
|
|
27813
|
+
/**
|
|
27814
|
+
* Waits for the live session's in-flight managed-settings application, then returns the retained effective snapshot used by runtime enforcement and by `session.managed_settings_resolved`. It does not perform another account, device, or server resolution, and rejects when resolution has not produced a snapshot.
|
|
27815
|
+
*
|
|
27816
|
+
* @returns Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values, then the policy helper, per ordinary key, while permissions compose restrictively across device, server, policy-helper, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes.
|
|
27817
|
+
*/
|
|
27818
|
+
get: () => Promise<ManagedSettingsResolvedData>;
|
|
27819
|
+
};
|
|
27820
|
+
/** @experimental */
|
|
25102
27821
|
plugins: {
|
|
25103
27822
|
/**
|
|
25104
|
-
* Lists
|
|
27823
|
+
* Lists globally installed, live, built-in, and enterprise-managed desired plugins using the live session's authoritative account, working directory, and retained managed policy.
|
|
25105
27824
|
*
|
|
25106
27825
|
* @returns Plugins installed for the session, with their enabled state and version metadata.
|
|
25107
27826
|
*/
|
|
25108
27827
|
list: () => Promise<PluginList>;
|
|
27828
|
+
/**
|
|
27829
|
+
* Installs a plugin using the live session's authoritative account, working directory, and retained managed policy.
|
|
27830
|
+
*
|
|
27831
|
+
* @param params Plugin source resolved relative to the session's authoritative working directory.
|
|
27832
|
+
*
|
|
27833
|
+
* @returns Result of installing a plugin.
|
|
27834
|
+
*/
|
|
27835
|
+
install: (params: SessionPluginsInstallRequest) => Promise<PluginInstallResult>;
|
|
27836
|
+
/**
|
|
27837
|
+
* Uninstalls a plugin when permitted by the live session's retained managed policy.
|
|
27838
|
+
*
|
|
27839
|
+
* @param params Name (or spec) of the plugin to uninstall.
|
|
27840
|
+
*/
|
|
27841
|
+
uninstall: (params: PluginsUninstallRequest) => Promise<void>;
|
|
27842
|
+
/**
|
|
27843
|
+
* Updates an installed plugin using the live session's authoritative account, working directory, and retained managed policy.
|
|
27844
|
+
*
|
|
27845
|
+
* @param params Name (or spec) of the plugin to update.
|
|
27846
|
+
*
|
|
27847
|
+
* @returns Result of updating a single plugin.
|
|
27848
|
+
*/
|
|
27849
|
+
update: (params: PluginsUpdateRequest) => Promise<PluginUpdateResult>;
|
|
27850
|
+
/**
|
|
27851
|
+
* Enables installed plugins when permitted by the live session's retained managed policy.
|
|
27852
|
+
*
|
|
27853
|
+
* @param params Plugin names (or specs) to enable in the session's authoritative working directory.
|
|
27854
|
+
*/
|
|
27855
|
+
enable: (params: SessionPluginsEnableRequest) => Promise<void>;
|
|
27856
|
+
/**
|
|
27857
|
+
* Disables installed plugins when permitted by the live session's retained managed policy.
|
|
27858
|
+
*
|
|
27859
|
+
* @param params Plugin names (or specs) to disable in the session's authoritative working directory.
|
|
27860
|
+
*/
|
|
27861
|
+
disable: (params: SessionPluginsDisableRequest) => Promise<void>;
|
|
27862
|
+
/** @experimental */
|
|
27863
|
+
marketplaces: {
|
|
27864
|
+
/**
|
|
27865
|
+
* Lists registered and enterprise-managed desired marketplaces using the live session's retained policy.
|
|
27866
|
+
*
|
|
27867
|
+
* @returns All registered marketplaces, including built-in defaults.
|
|
27868
|
+
*/
|
|
27869
|
+
list: () => Promise<MarketplaceListResult>;
|
|
27870
|
+
/**
|
|
27871
|
+
* Adds a marketplace when permitted by the live session's retained managed policy.
|
|
27872
|
+
*
|
|
27873
|
+
* @param params Marketplace source and optional working directory for relative-path resolution.
|
|
27874
|
+
*
|
|
27875
|
+
* @returns Result of registering a new marketplace.
|
|
27876
|
+
*/
|
|
27877
|
+
add: (params: PluginsMarketplacesAddRequest) => Promise<MarketplaceAddResult>;
|
|
27878
|
+
/**
|
|
27879
|
+
* Removes a marketplace when permitted by the live session's retained managed policy.
|
|
27880
|
+
*
|
|
27881
|
+
* @param params Name of the marketplace to remove and an optional force flag.
|
|
27882
|
+
*
|
|
27883
|
+
* @returns Outcome of the remove attempt, including dependent-plugin info when applicable.
|
|
27884
|
+
*/
|
|
27885
|
+
remove: (params: PluginsMarketplacesRemoveRequest) => Promise<MarketplaceRemoveResult>;
|
|
27886
|
+
/**
|
|
27887
|
+
* Browses a marketplace resolved through the live session's working directory and retained managed policy.
|
|
27888
|
+
*
|
|
27889
|
+
* @param params Name of the marketplace whose plugin catalog to fetch.
|
|
27890
|
+
*
|
|
27891
|
+
* @returns Plugins advertised by the marketplace.
|
|
27892
|
+
*/
|
|
27893
|
+
browse: (params: PluginsMarketplacesBrowseRequest) => Promise<MarketplaceBrowseResult>;
|
|
27894
|
+
/**
|
|
27895
|
+
* Refreshes marketplaces resolved through the live session's working directory and retained managed policy.
|
|
27896
|
+
*
|
|
27897
|
+
* @param params Optional marketplace name; omit to refresh all.
|
|
27898
|
+
*
|
|
27899
|
+
* @returns Result of refreshing one or more marketplace catalogs.
|
|
27900
|
+
*/
|
|
27901
|
+
refresh: (params?: SessionPluginsMarketplacesRefreshRequest) => Promise<MarketplaceRefreshResult>;
|
|
27902
|
+
};
|
|
25109
27903
|
/**
|
|
25110
27904
|
* Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately.
|
|
25111
27905
|
*
|
|
@@ -25131,6 +27925,14 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25131
27925
|
* @returns The selectable model entries synthesized for the models added by this call.
|
|
25132
27926
|
*/
|
|
25133
27927
|
add: (params: ProviderAddRequest) => Promise<ProviderAddResult>;
|
|
27928
|
+
/**
|
|
27929
|
+
* Atomically updates the session's BYOK provider and model registry by applying the supplied snapshot, replacing existing entries, updating models, or removing entries absent from the snapshot.
|
|
27930
|
+
*
|
|
27931
|
+
* @param params Authoritative BYOK provider and model registry snapshot to apply atomically to the session.
|
|
27932
|
+
*
|
|
27933
|
+
* @returns The selectable model entries and selection ids synthesized for the synchronized BYOK models.
|
|
27934
|
+
*/
|
|
27935
|
+
sync: (params: ProviderSyncRequest) => Promise<ProviderSyncResult>;
|
|
25134
27936
|
};
|
|
25135
27937
|
/** @experimental */
|
|
25136
27938
|
options: {
|
|
@@ -25456,9 +28258,9 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25456
28258
|
*/
|
|
25457
28259
|
setRequired: (params: PermissionsSetRequiredRequest) => Promise<PermissionsSetRequiredResult>;
|
|
25458
28260
|
/**
|
|
25459
|
-
* Clears session-scoped tool
|
|
28261
|
+
* Clears session-scoped tool approvals and, for full resets, exact session-approved paths.
|
|
25460
28262
|
*
|
|
25461
|
-
* @param params Clears session-scoped tool
|
|
28263
|
+
* @param params Clears session-scoped tool approvals and optionally clears location-scoped approvals and exact session-approved paths.
|
|
25462
28264
|
*
|
|
25463
28265
|
* @returns Indicates whether the operation succeeded.
|
|
25464
28266
|
*/
|
|
@@ -25474,9 +28276,9 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25474
28276
|
/** @experimental */
|
|
25475
28277
|
paths: {
|
|
25476
28278
|
/**
|
|
25477
|
-
* Returns the session's
|
|
28279
|
+
* Returns the session's recursive directory grants, exact session-approved paths, and primary working directory.
|
|
25478
28280
|
*
|
|
25479
|
-
* @returns Snapshot of the session's
|
|
28281
|
+
* @returns Snapshot of the session's recursive directory grants, exact session-approved paths, and primary working directory.
|
|
25480
28282
|
*/
|
|
25481
28283
|
list: () => Promise<PermissionPathsList>;
|
|
25482
28284
|
/**
|
|
@@ -25814,6 +28616,22 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25814
28616
|
* @returns Result of editing a queued message.
|
|
25815
28617
|
*/
|
|
25816
28618
|
updateText: (params: QueueUpdateTextRequest) => Promise<QueueUpdateTextResult>;
|
|
28619
|
+
/**
|
|
28620
|
+
* Atomically withdraws an unchanged, unconsumed user message from the local queued or steering lane. A client retaining the original draft may restore it only when removed is true. Does not interrupt the running turn.
|
|
28621
|
+
*
|
|
28622
|
+
* @param params Conditional withdrawal of a single user message, before the runtime claims it for delivery.
|
|
28623
|
+
*
|
|
28624
|
+
* @returns Result of removing a queued item.
|
|
28625
|
+
*/
|
|
28626
|
+
withdrawMessage: (params: QueueWithdrawMessageRequest) => Promise<QueueRemoveAtResult>;
|
|
28627
|
+
/**
|
|
28628
|
+
* Atomically appends text and attachments to an unchanged, unconsumed local steering message. Returns updated=false if delivery or withdrawal already claimed the message.
|
|
28629
|
+
*
|
|
28630
|
+
* @param params Append to one pending steering message without changing its identity or delivery position.
|
|
28631
|
+
*
|
|
28632
|
+
* @returns Result of editing a queued message.
|
|
28633
|
+
*/
|
|
28634
|
+
appendSteering: (params: QueueAppendSteeringRequest) => Promise<QueueUpdateTextResult>;
|
|
25817
28635
|
/**
|
|
25818
28636
|
* Duplicates an addressable queued item immediately after its source.
|
|
25819
28637
|
*
|
|
@@ -25990,6 +28808,26 @@ export interface FactoryHandler {
|
|
|
25990
28808
|
*/
|
|
25991
28809
|
abort(params: FactoryAbortRequest): Promise<FactoryAckResult>;
|
|
25992
28810
|
}
|
|
28811
|
+
/** Handler for `workflow` client session API methods. */
|
|
28812
|
+
/** @experimental */
|
|
28813
|
+
export interface WorkflowHandler {
|
|
28814
|
+
/**
|
|
28815
|
+
* Asks the owning extension connection to execute a registered dynamic workflow.
|
|
28816
|
+
*
|
|
28817
|
+
* @param params Parameters sent to the owning extension to execute a workflow closure.
|
|
28818
|
+
*
|
|
28819
|
+
* @returns Result returned by an extension workflow closure.
|
|
28820
|
+
*/
|
|
28821
|
+
execute(params: WorkflowExecuteRequest): Promise<WorkflowExecuteResult>;
|
|
28822
|
+
/**
|
|
28823
|
+
* Asks the owning extension connection to abort a running dynamic workflow cooperatively.
|
|
28824
|
+
*
|
|
28825
|
+
* @param params Parameters for cooperatively aborting a workflow body.
|
|
28826
|
+
*
|
|
28827
|
+
* @returns Acknowledgement that a workflow request was accepted.
|
|
28828
|
+
*/
|
|
28829
|
+
abort(params: WorkflowAbortRequest): Promise<WorkflowAckResult>;
|
|
28830
|
+
}
|
|
25993
28831
|
/** Handler for `tasks` client session API methods. */
|
|
25994
28832
|
/** @experimental */
|
|
25995
28833
|
export interface TasksHandler {
|
|
@@ -26140,6 +28978,7 @@ export interface CanvasHandler {
|
|
|
26140
28978
|
export interface ClientSessionApiHandlers {
|
|
26141
28979
|
providerToken?: ProviderTokenHandler;
|
|
26142
28980
|
factory?: FactoryHandler;
|
|
28981
|
+
workflow?: WorkflowHandler;
|
|
26143
28982
|
tasks?: TasksHandler;
|
|
26144
28983
|
sessionFs?: SessionFsHandler;
|
|
26145
28984
|
canvas?: CanvasHandler;
|
|
@@ -26187,7 +29026,7 @@ export interface LlmInferenceHandler {
|
|
|
26187
29026
|
/** @experimental */
|
|
26188
29027
|
export interface GitHubTelemetryHandler {
|
|
26189
29028
|
/**
|
|
26190
|
-
* Forwards a single GitHub telemetry event to a host connection that opted into telemetry forwarding during the `server.connect` handshake. Opted-in connections receive
|
|
29029
|
+
* Forwards a single GitHub telemetry event to a host connection that opted into telemetry forwarding during the `server.connect` handshake. Opted-in connections receive their runtime host's events across all its sessions, its sessionless events (for example, `server.sendTelemetry`), and explicitly process-wide events. Events owned by another independently embedded runtime host are not forwarded to this connection.
|
|
26191
29030
|
*
|
|
26192
29031
|
* @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.
|
|
26193
29032
|
*/
|