@github/copilot-sdk 1.0.14 → 1.0.15-preview.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +116 -11
- package/dist/cjs/cliVersion.js +1 -1
- package/dist/cjs/client.js +24 -17
- package/dist/cjs/copilotRequestHandler.js +156 -20
- package/dist/cjs/extension.js +12 -1
- package/dist/cjs/generated/rpc.js +349 -8
- package/dist/cjs/index.js +9 -2
- package/dist/cjs/schema.js +40 -0
- package/dist/cjs/session.js +625 -3
- package/dist/cjs/workflow.js +134 -0
- package/dist/cliVersion.d.ts +1 -1
- package/dist/cliVersion.js +1 -1
- package/dist/client.d.ts +2 -0
- package/dist/client.js +22 -15
- package/dist/copilotRequestHandler.js +156 -20
- package/dist/extension.d.ts +22 -8
- package/dist/extension.js +13 -1
- package/dist/generated/rpc.d.ts +2824 -315
- package/dist/generated/rpc.js +349 -8
- package/dist/generated/session-events.d.ts +565 -2
- package/dist/index.d.ts +3 -1
- package/dist/index.js +5 -1
- package/dist/schema.d.ts +4 -0
- package/dist/schema.js +14 -0
- package/dist/session.d.ts +26 -3
- package/dist/session.js +630 -3
- package/dist/types.d.ts +37 -5
- package/dist/workflow.d.ts +364 -0
- package/dist/workflow.js +106 -0
- package/docs/extensions.md +1 -0
- package/docs/workflows.md +257 -0
- package/package.json +17 -14
package/dist/generated/rpc.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Generated from: api.schema.json
|
|
4
4
|
*/
|
|
5
5
|
import type { MessageConnection } from "vscode-jsonrpc/node.js";
|
|
6
|
-
import type { AbortReason, 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;
|
|
@@ -152,7 +152,7 @@ export type AgentRegistryLiveTargetEntryLastTerminalEvent =
|
|
|
152
152
|
/** Last turn was aborted (e.g. user interrupted) */
|
|
153
153
|
| "abort";
|
|
154
154
|
/**
|
|
155
|
-
* Categorized reason
|
|
155
|
+
* Categorized reason no canonical process log could be opened
|
|
156
156
|
*
|
|
157
157
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
158
158
|
* via the `definition` "AgentRegistryLogCaptureOpenErrorReason".
|
|
@@ -326,13 +326,53 @@ export type CardDigestAlgorithm = "sha256-rfc8785";
|
|
|
326
326
|
/** @experimental */
|
|
327
327
|
export type CardDigestValue = string;
|
|
328
328
|
/**
|
|
329
|
-
*
|
|
329
|
+
* Discriminator for an Agent Plugin candidate
|
|
330
330
|
*
|
|
331
331
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
332
|
-
* via the `definition` "
|
|
332
|
+
* via the `definition` "CatalogAgentPluginCandidateKind".
|
|
333
333
|
*/
|
|
334
334
|
/** @experimental */
|
|
335
|
-
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";
|
|
336
376
|
/**
|
|
337
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.
|
|
338
378
|
*
|
|
@@ -451,6 +491,38 @@ export type CatalogTrustSnapshotUnsupportedStatus =
|
|
|
451
491
|
export type CatalogTrustSnapshotMalformedStatus =
|
|
452
492
|
/** The trust field was empty, unbounded, or had the wrong JSON type. */
|
|
453
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;
|
|
454
526
|
/**
|
|
455
527
|
* Why the catalog authority did not accept the caller's identity
|
|
456
528
|
*
|
|
@@ -466,13 +538,21 @@ export type CatalogAuthenticationRequiredReason =
|
|
|
466
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. */
|
|
467
539
|
| "credential-rejected";
|
|
468
540
|
/**
|
|
469
|
-
* 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.
|
|
470
542
|
*
|
|
471
543
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
472
544
|
* via the `definition` "CatalogCandidate".
|
|
473
545
|
*/
|
|
474
546
|
/** @experimental */
|
|
475
|
-
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";
|
|
476
556
|
/**
|
|
477
557
|
* JSON MCP card media type accepted for install planning
|
|
478
558
|
*
|
|
@@ -508,7 +588,9 @@ export type CatalogCandidateKind =
|
|
|
508
588
|
/** An MCP server, which can be planned for installation. */
|
|
509
589
|
"mcp-server"
|
|
510
590
|
/** An AI skill, which is discoverable but not installable through this surface. */
|
|
511
|
-
| "ai-skill"
|
|
591
|
+
| "ai-skill"
|
|
592
|
+
/** An inert Agent Plugin candidate, available only when explicitly requested. */
|
|
593
|
+
| "plugin";
|
|
512
594
|
/**
|
|
513
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.
|
|
514
596
|
*
|
|
@@ -523,12 +605,20 @@ export type CatalogCapability =
|
|
|
523
605
|
| "legacy-mcp-server-card"
|
|
524
606
|
/** Understands `application/ai-skill` candidates as discovery-only and typed non-installable. */
|
|
525
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"
|
|
526
610
|
/** Understands side-effect-free MCP install-plan requests, results, and plan handles; `planning-unavailable` separately reports that planning is not enabled. */
|
|
527
611
|
| "mcp-install-planning"
|
|
528
612
|
/** Understands plans that enumerate every eligible transport rather than a single preferred one. */
|
|
529
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"
|
|
530
616
|
/** Understands versioned candidate trust snapshots. Protocol-3 callers must require this capability before the runtime adds the optional snapshot field. */
|
|
531
|
-
| "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";
|
|
532
622
|
/**
|
|
533
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.
|
|
534
624
|
*
|
|
@@ -549,7 +639,7 @@ export type CatalogContractViolationReason =
|
|
|
549
639
|
"both-url-and-data"
|
|
550
640
|
/** A result carried neither a URL nor embedded data, when exactly one is required. */
|
|
551
641
|
| "neither-url-nor-data"
|
|
552
|
-
/** 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. */
|
|
553
643
|
| "duplicate-identity"
|
|
554
644
|
/** A result declared no media type, or one this contract does not model. */
|
|
555
645
|
| "unknown-media-type";
|
|
@@ -564,7 +654,9 @@ export type CatalogHandleType =
|
|
|
564
654
|
/** A search candidate handle. */
|
|
565
655
|
"candidate"
|
|
566
656
|
/** An install plan handle. */
|
|
567
|
-
| "plan"
|
|
657
|
+
| "plan"
|
|
658
|
+
/** A model-safe reference to one retained search candidate. */
|
|
659
|
+
| "selection";
|
|
568
660
|
/**
|
|
569
661
|
* Why a presented handle was rejected
|
|
570
662
|
*
|
|
@@ -573,16 +665,20 @@ export type CatalogHandleType =
|
|
|
573
665
|
*/
|
|
574
666
|
/** @experimental */
|
|
575
667
|
export type CatalogHandleRejectionReason =
|
|
576
|
-
/** The handle is unparseable
|
|
668
|
+
/** The handle is unparseable or unknown. */
|
|
577
669
|
"invalid"
|
|
578
670
|
/** The handle's time to live has elapsed. */
|
|
579
671
|
| "stale"
|
|
580
672
|
/** The handle has already been used, and handles are single-use. */
|
|
581
673
|
| "replayed"
|
|
582
|
-
/** The handle was issued by a different runtime instance. */
|
|
583
|
-
| "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";
|
|
584
680
|
/**
|
|
585
|
-
* Which request field was rejected
|
|
681
|
+
* Which request field was rejected locally or by the catalog authority
|
|
586
682
|
*
|
|
587
683
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
588
684
|
* via the `definition` "CatalogInvalidRequestField".
|
|
@@ -602,7 +698,15 @@ export type CatalogInvalidRequestField =
|
|
|
602
698
|
/** The supplied card was missing its media type, URL, or data. */
|
|
603
699
|
| "card"
|
|
604
700
|
/** The requested configuration scope is not one this runtime writes. */
|
|
605
|
-
| "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";
|
|
606
710
|
/**
|
|
607
711
|
* How a card failed validation
|
|
608
712
|
*
|
|
@@ -634,7 +738,9 @@ export type CatalogMediaType =
|
|
|
634
738
|
/** The legacy MCP server card media type, accepted for compatibility. */
|
|
635
739
|
| "application/mcp-server+json"
|
|
636
740
|
/** An AI skill card. Representable and searchable, but typed non-installable. */
|
|
637
|
-
| "application/ai-skill"
|
|
741
|
+
| "application/ai-skill"
|
|
742
|
+
/** An inert Agent Plugin descriptor. */
|
|
743
|
+
| "application/vnd.github.copilot-plugin";
|
|
638
744
|
/**
|
|
639
745
|
* Why capability and protocol-version negotiation refused a caller
|
|
640
746
|
*
|
|
@@ -707,6 +813,16 @@ export type McpPlanPolicySource =
|
|
|
707
813
|
| "registry-policy"
|
|
708
814
|
/** Local trust settings evaluated the server. */
|
|
709
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";
|
|
710
826
|
/**
|
|
711
827
|
* Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success.
|
|
712
828
|
*
|
|
@@ -747,10 +863,36 @@ export type CatalogUnavailableReason =
|
|
|
747
863
|
"search-unavailable"
|
|
748
864
|
/** Install planning is not wired up on this runtime build. */
|
|
749
865
|
| "planning-unavailable"
|
|
866
|
+
/** Exact candidate selection is not available in this session or runtime. */
|
|
867
|
+
| "selection-unavailable"
|
|
750
868
|
/** No catalog authority is configured for this runtime. */
|
|
751
869
|
| "authority-not-configured"
|
|
752
870
|
/** The surface is disabled by policy on this runtime. */
|
|
753
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;
|
|
754
896
|
/**
|
|
755
897
|
* Why no usable transport could be offered
|
|
756
898
|
*
|
|
@@ -856,6 +998,106 @@ export type ConnectedRemoteSessionMetadataKind =
|
|
|
856
998
|
"remote-session"
|
|
857
999
|
/** GitHub Copilot coding agent session. */
|
|
858
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";
|
|
859
1101
|
/**
|
|
860
1102
|
* Closed set of public task kinds a connection can negotiate.
|
|
861
1103
|
*
|
|
@@ -1068,6 +1310,14 @@ export type DiscoveredMcpServerType =
|
|
|
1068
1310
|
| "sse"
|
|
1069
1311
|
/** Server is backed by an in-memory runtime implementation. */
|
|
1070
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;
|
|
1071
1321
|
/**
|
|
1072
1322
|
* Either '*' to receive all event types, or a non-empty list of event types to receive
|
|
1073
1323
|
*
|
|
@@ -3994,72 +4244,275 @@ export type UISessionLimitsExhaustedResponseAction =
|
|
|
3994
4244
|
/** Leave the limit unchanged and cancel the blocked model request. */
|
|
3995
4245
|
| "cancel";
|
|
3996
4246
|
/**
|
|
3997
|
-
*
|
|
3998
|
-
*
|
|
3999
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4000
|
-
* via the `definition` "WorkspaceDiffFileChangeType".
|
|
4001
|
-
*/
|
|
4002
|
-
/** @experimental */
|
|
4003
|
-
export type WorkspaceDiffFileChangeType =
|
|
4004
|
-
/** The file was added. */
|
|
4005
|
-
"added"
|
|
4006
|
-
/** The file was modified. */
|
|
4007
|
-
| "modified"
|
|
4008
|
-
/** The file was deleted. */
|
|
4009
|
-
| "deleted"
|
|
4010
|
-
/** The file was renamed. */
|
|
4011
|
-
| "renamed";
|
|
4012
|
-
/**
|
|
4013
|
-
* Diff mode requested by the client.
|
|
4247
|
+
* Execution-critical workflow storage operation.
|
|
4014
4248
|
*
|
|
4015
4249
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4016
|
-
* via the `definition` "
|
|
4250
|
+
* via the `definition` "WorkflowDurableOperation".
|
|
4017
4251
|
*/
|
|
4018
4252
|
/** @experimental */
|
|
4019
|
-
export type
|
|
4020
|
-
/**
|
|
4021
|
-
"
|
|
4022
|
-
/**
|
|
4023
|
-
| "
|
|
4024
|
-
/**
|
|
4025
|
-
| "
|
|
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";
|
|
4026
4276
|
/**
|
|
4027
|
-
*
|
|
4277
|
+
* Current or terminal state of a workflow run.
|
|
4028
4278
|
*
|
|
4029
4279
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4030
|
-
* via the `definition` "
|
|
4280
|
+
* via the `definition` "WorkflowRunStatus".
|
|
4031
4281
|
*/
|
|
4032
4282
|
/** @experimental */
|
|
4033
|
-
export type
|
|
4034
|
-
/**
|
|
4035
|
-
"
|
|
4036
|
-
/**
|
|
4037
|
-
| "
|
|
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";
|
|
4038
4298
|
/**
|
|
4039
|
-
*
|
|
4299
|
+
* Machine-readable workflow run failure.
|
|
4040
4300
|
*
|
|
4041
4301
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4042
|
-
* via the `definition` "
|
|
4302
|
+
* via the `definition` "WorkflowRunFailure".
|
|
4043
4303
|
*/
|
|
4044
4304
|
/** @experimental */
|
|
4045
|
-
export type
|
|
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
|
+
};
|
|
4046
4373
|
/**
|
|
4047
|
-
*
|
|
4374
|
+
* Cumulative resource ceiling that stopped a workflow run.
|
|
4048
4375
|
*
|
|
4049
4376
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4050
|
-
* via the `definition` "
|
|
4377
|
+
* via the `definition` "WorkflowRunFailureKind".
|
|
4051
4378
|
*/
|
|
4052
4379
|
/** @experimental */
|
|
4053
|
-
export type
|
|
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";
|
|
4054
4387
|
/**
|
|
4055
|
-
*
|
|
4388
|
+
* Durable metadata describing who initiated a workflow pause.
|
|
4056
4389
|
*
|
|
4057
4390
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4058
|
-
* via the `definition` "
|
|
4391
|
+
* via the `definition` "WorkflowPauseInfo".
|
|
4059
4392
|
*/
|
|
4060
4393
|
/** @experimental */
|
|
4061
|
-
export type
|
|
4062
|
-
/**
|
|
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
|
+
/**
|
|
4063
4516
|
* Whether the current authentication was logged out.
|
|
4064
4517
|
*
|
|
4065
4518
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
@@ -4102,6 +4555,17 @@ export interface AbortResult {
|
|
|
4102
4555
|
*/
|
|
4103
4556
|
error?: string;
|
|
4104
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
|
+
}
|
|
4105
4569
|
/**
|
|
4106
4570
|
* Authenticated account entry returned by `account.getAllUsers`.
|
|
4107
4571
|
*
|
|
@@ -4212,6 +4676,15 @@ export interface CopilotUserResponse {
|
|
|
4212
4676
|
[k: string]: unknown | undefined;
|
|
4213
4677
|
} | string) | null;
|
|
4214
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;
|
|
4215
4688
|
/**
|
|
4216
4689
|
* Whether the Codex agent is enabled for the user.
|
|
4217
4690
|
*/
|
|
@@ -4845,7 +5318,7 @@ export interface AgentGetCurrentResult {
|
|
|
4845
5318
|
agent?: AgentInfo | null;
|
|
4846
5319
|
}
|
|
4847
5320
|
/**
|
|
4848
|
-
* 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.
|
|
4849
5322
|
*
|
|
4850
5323
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4851
5324
|
* via the `definition` "AgentInfo".
|
|
@@ -4894,6 +5367,10 @@ export interface AgentInfo {
|
|
|
4894
5367
|
*/
|
|
4895
5368
|
models?: string[];
|
|
4896
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;
|
|
4897
5374
|
/**
|
|
4898
5375
|
* MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema.
|
|
4899
5376
|
*
|
|
@@ -4990,7 +5467,7 @@ export interface AgentRegistryLiveTargetEntry {
|
|
|
4990
5467
|
lastSeenMs: number;
|
|
4991
5468
|
}
|
|
4992
5469
|
/**
|
|
4993
|
-
*
|
|
5470
|
+
* Canonical process-log discovery outcome; populated from spawnLiveTarget.
|
|
4994
5471
|
*
|
|
4995
5472
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4996
5473
|
* via the `definition` "AgentRegistryLogCapture".
|
|
@@ -4998,15 +5475,15 @@ export interface AgentRegistryLiveTargetEntry {
|
|
|
4998
5475
|
/** @experimental */
|
|
4999
5476
|
export interface AgentRegistryLogCapture {
|
|
5000
5477
|
/**
|
|
5001
|
-
* Whether
|
|
5478
|
+
* Whether a canonical process log was discovered for this managed spawn
|
|
5002
5479
|
*/
|
|
5003
5480
|
enabled: boolean;
|
|
5004
5481
|
/**
|
|
5005
|
-
* Absolute path to the
|
|
5482
|
+
* Absolute path to the managed spawn's process-<timestamp>-<pid>.log file (only set when enabled)
|
|
5006
5483
|
*/
|
|
5007
5484
|
path?: string;
|
|
5008
5485
|
/**
|
|
5009
|
-
*
|
|
5486
|
+
* Why no canonical process log could be opened for this managed spawn (set only when enabled is false)
|
|
5010
5487
|
*/
|
|
5011
5488
|
openError?: string;
|
|
5012
5489
|
openErrorReason?: AgentRegistryLogCaptureOpenErrorReason;
|
|
@@ -5849,33 +6326,17 @@ export interface CardDigest {
|
|
|
5849
6326
|
value: CardDigestValue;
|
|
5850
6327
|
}
|
|
5851
6328
|
/**
|
|
5852
|
-
* 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.
|
|
5853
6330
|
*
|
|
5854
6331
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5855
|
-
* via the `definition` "
|
|
6332
|
+
* via the `definition` "CatalogAgentPluginCandidate".
|
|
5856
6333
|
*/
|
|
5857
6334
|
/** @experimental */
|
|
5858
|
-
export interface
|
|
5859
|
-
|
|
5860
|
-
|
|
5861
|
-
|
|
5862
|
-
|
|
5863
|
-
/**
|
|
5864
|
-
* ISO 8601 timestamp after which the handle is stale and will be rejected.
|
|
5865
|
-
*/
|
|
5866
|
-
handleExpiresAt: string;
|
|
5867
|
-
/**
|
|
5868
|
-
* Discriminator: this candidate describes an AI skill
|
|
5869
|
-
*/
|
|
5870
|
-
kind: "ai-skill";
|
|
5871
|
-
/**
|
|
5872
|
-
* Media type of the underlying AI skill card
|
|
5873
|
-
*/
|
|
5874
|
-
mediaType: "application/ai-skill";
|
|
5875
|
-
/**
|
|
5876
|
-
* AI skills are discovery-only and cannot be installed through this surface
|
|
5877
|
-
*/
|
|
5878
|
-
installability: "not-installable-kind";
|
|
6335
|
+
export interface CatalogAgentPluginCandidate {
|
|
6336
|
+
kind: CatalogAgentPluginCandidateKind;
|
|
6337
|
+
mediaType: CatalogAgentPluginMediaType;
|
|
6338
|
+
identity: CatalogResourceIdentity;
|
|
6339
|
+
version?: CatalogResourceVersion;
|
|
5879
6340
|
/**
|
|
5880
6341
|
* Display name taken verbatim from the card. Inert untrusted text.
|
|
5881
6342
|
*/
|
|
@@ -5888,48 +6349,43 @@ export interface CatalogAiSkillCandidate {
|
|
|
5888
6349
|
* Publisher taken verbatim from the card. Inert untrusted text.
|
|
5889
6350
|
*/
|
|
5890
6351
|
publisher?: string;
|
|
5891
|
-
source:
|
|
5892
|
-
|
|
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;
|
|
5893
6362
|
trust?: CatalogTrustSnapshot;
|
|
5894
6363
|
}
|
|
5895
6364
|
/**
|
|
5896
|
-
*
|
|
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.
|
|
5897
6366
|
*
|
|
5898
6367
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5899
|
-
* via the `definition` "
|
|
6368
|
+
* via the `definition` "CatalogPluginRepositorySource".
|
|
5900
6369
|
*/
|
|
5901
6370
|
/** @experimental */
|
|
5902
|
-
export interface
|
|
5903
|
-
/**
|
|
5904
|
-
* Discriminator: the card is URL-backed, and carries no embedded data
|
|
5905
|
-
*/
|
|
5906
|
-
kind: "url";
|
|
6371
|
+
export interface CatalogPluginRepositorySource {
|
|
5907
6372
|
/**
|
|
5908
|
-
*
|
|
6373
|
+
* Canonical lowercase owner/repository name derived from metadata.sourceSet.
|
|
5909
6374
|
*/
|
|
5910
|
-
|
|
5911
|
-
}
|
|
5912
|
-
/**
|
|
5913
|
-
* Candidate whose card reference arrived inline. The document and its content-derived properties stay behind the runtime boundary.
|
|
5914
|
-
*
|
|
5915
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5916
|
-
* via the `definition` "CatalogCandidateSourceEmbedded".
|
|
5917
|
-
*/
|
|
5918
|
-
/** @experimental */
|
|
5919
|
-
export interface CatalogCandidateSourceEmbedded {
|
|
6375
|
+
repository: string;
|
|
5920
6376
|
/**
|
|
5921
|
-
*
|
|
6377
|
+
* Case-preserving safe relative POSIX path derived from metadata.repoPath.
|
|
5922
6378
|
*/
|
|
5923
|
-
|
|
6379
|
+
path: string;
|
|
5924
6380
|
}
|
|
5925
6381
|
/**
|
|
5926
|
-
* 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.
|
|
5927
6383
|
*
|
|
5928
6384
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5929
|
-
* via the `definition` "
|
|
6385
|
+
* via the `definition` "CatalogAgentPluginCandidateProvenance".
|
|
5930
6386
|
*/
|
|
5931
6387
|
/** @experimental */
|
|
5932
|
-
export interface
|
|
6388
|
+
export interface CatalogAgentPluginCandidateProvenance {
|
|
5933
6389
|
/**
|
|
5934
6390
|
* Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data.
|
|
5935
6391
|
*/
|
|
@@ -5938,10 +6394,7 @@ export interface CatalogAiSkillCandidateProvenance {
|
|
|
5938
6394
|
* ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp.
|
|
5939
6395
|
*/
|
|
5940
6396
|
observedAt: string;
|
|
5941
|
-
|
|
5942
|
-
* Media type advertised for the referenced AI skill card
|
|
5943
|
-
*/
|
|
5944
|
-
mediaType: "application/ai-skill";
|
|
6397
|
+
mediaType: CatalogAgentPluginMediaType;
|
|
5945
6398
|
}
|
|
5946
6399
|
/**
|
|
5947
6400
|
* A recognised current Agent Finder T1 or T2 trust tier.
|
|
@@ -6049,6 +6502,89 @@ export interface CatalogTrustSnapshotMalformed {
|
|
|
6049
6502
|
eligibility: CatalogTrustEligibility;
|
|
6050
6503
|
provenance: CatalogTrustProvenance;
|
|
6051
6504
|
}
|
|
6505
|
+
/**
|
|
6506
|
+
* An inert AI skill catalog result. AI skills are discovery-only and cannot be represented as installable through this surface.
|
|
6507
|
+
*
|
|
6508
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6509
|
+
* via the `definition` "CatalogAiSkillCandidate".
|
|
6510
|
+
*/
|
|
6511
|
+
/** @experimental */
|
|
6512
|
+
export interface CatalogAiSkillCandidate {
|
|
6513
|
+
/**
|
|
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.
|
|
6515
|
+
*/
|
|
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
|
+
}
|
|
6052
6588
|
/**
|
|
6053
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.
|
|
6054
6590
|
*
|
|
@@ -6083,10 +6619,7 @@ export interface CatalogMcpServerCandidate {
|
|
|
6083
6619
|
* ISO 8601 timestamp after which the handle is stale and will be rejected.
|
|
6084
6620
|
*/
|
|
6085
6621
|
handleExpiresAt: string;
|
|
6086
|
-
|
|
6087
|
-
* Discriminator: this candidate describes an MCP server
|
|
6088
|
-
*/
|
|
6089
|
-
kind: "mcp-server";
|
|
6622
|
+
kind: CatalogMcpServerCandidateKind;
|
|
6090
6623
|
mediaType: McpServerCardMediaType;
|
|
6091
6624
|
installability: CatalogMcpServerInstallability;
|
|
6092
6625
|
/**
|
|
@@ -6180,7 +6713,7 @@ export interface CatalogHandleRejectedError {
|
|
|
6180
6713
|
message: string;
|
|
6181
6714
|
}
|
|
6182
6715
|
/**
|
|
6183
|
-
* 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.
|
|
6184
6717
|
*
|
|
6185
6718
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6186
6719
|
* via the `definition` "CatalogInvalidRequestError".
|
|
@@ -6229,7 +6762,7 @@ export interface CatalogNegotiatedContract {
|
|
|
6229
6762
|
*/
|
|
6230
6763
|
runtimeProtocolVersion: number;
|
|
6231
6764
|
/**
|
|
6232
|
-
* 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.
|
|
6233
6766
|
*/
|
|
6234
6767
|
grantedCapabilities: CatalogCapability[];
|
|
6235
6768
|
}
|
|
@@ -6334,13 +6867,68 @@ export interface CatalogPolicyRejectedError {
|
|
|
6334
6867
|
message: string;
|
|
6335
6868
|
}
|
|
6336
6869
|
/**
|
|
6337
|
-
*
|
|
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.
|
|
6338
6871
|
*
|
|
6339
6872
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6340
|
-
* via the `definition` "
|
|
6873
|
+
* via the `definition` "CatalogSearchPage".
|
|
6341
6874
|
*/
|
|
6342
6875
|
/** @experimental */
|
|
6343
|
-
export interface
|
|
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
|
+
}
|
|
6924
|
+
/**
|
|
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.
|
|
6926
|
+
*
|
|
6927
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6928
|
+
* via the `definition` "CatalogSearchRequest".
|
|
6929
|
+
*/
|
|
6930
|
+
/** @experimental */
|
|
6931
|
+
export interface CatalogSearchRequest {
|
|
6344
6932
|
contract: CatalogClientContract;
|
|
6345
6933
|
/**
|
|
6346
6934
|
* Free-text search query. Persisted as tool input for session continuity, but omitted from telemetry.
|
|
@@ -6351,15 +6939,16 @@ export interface CatalogSearchRequest {
|
|
|
6351
6939
|
*/
|
|
6352
6940
|
limit?: number;
|
|
6353
6941
|
/**
|
|
6354
|
-
* 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.
|
|
6355
6943
|
*
|
|
6356
6944
|
* @minItems 1
|
|
6357
|
-
* @maxItems
|
|
6945
|
+
* @maxItems 3
|
|
6358
6946
|
*/
|
|
6359
|
-
kinds?: [CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind];
|
|
6947
|
+
kinds?: [CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind, CatalogCandidateKind];
|
|
6948
|
+
page?: CatalogSearchPage;
|
|
6360
6949
|
}
|
|
6361
6950
|
/**
|
|
6362
|
-
* 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.
|
|
6363
6952
|
*
|
|
6364
6953
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6365
6954
|
* via the `definition` "CatalogSearchSucceeded".
|
|
@@ -6381,10 +6970,11 @@ export interface CatalogSearchSucceeded {
|
|
|
6381
6970
|
*/
|
|
6382
6971
|
candidates: CatalogCandidate[];
|
|
6383
6972
|
/**
|
|
6384
|
-
*
|
|
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.
|
|
6385
6974
|
*/
|
|
6386
6975
|
truncated: boolean;
|
|
6387
6976
|
negotiated: CatalogNegotiatedContract;
|
|
6977
|
+
pagination?: CatalogSearchPagination;
|
|
6388
6978
|
}
|
|
6389
6979
|
/**
|
|
6390
6980
|
* The request asked for a candidate kind this runtime does not serve.
|
|
@@ -6447,6 +7037,182 @@ export interface CatalogUnavailableError {
|
|
|
6447
7037
|
*/
|
|
6448
7038
|
message: string;
|
|
6449
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
|
+
}
|
|
6450
7216
|
/**
|
|
6451
7217
|
* No transport this runtime can use is available for the requested server.
|
|
6452
7218
|
*
|
|
@@ -6882,187 +7648,414 @@ export interface ConnectedRemoteSessionMetadataRepository {
|
|
|
6882
7648
|
branch: string;
|
|
6883
7649
|
}
|
|
6884
7650
|
/**
|
|
6885
|
-
*
|
|
7651
|
+
* Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
|
|
6886
7652
|
*
|
|
6887
7653
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6888
|
-
* via the `definition` "
|
|
7654
|
+
* via the `definition` "ConnectorAccountRequest".
|
|
6889
7655
|
*/
|
|
6890
7656
|
/** @experimental */
|
|
6891
|
-
export interface
|
|
7657
|
+
export interface ConnectorAccountRequest {
|
|
6892
7658
|
/**
|
|
6893
|
-
*
|
|
7659
|
+
* Opaque account selection ID previously returned by an account discovery API.
|
|
6894
7660
|
*/
|
|
6895
|
-
|
|
7661
|
+
accountId: string;
|
|
6896
7662
|
}
|
|
6897
7663
|
/**
|
|
6898
|
-
*
|
|
7664
|
+
* Account-targeted authorization update required by the Connector service. The account ID is an opaque host routing identifier; no credential is included.
|
|
6899
7665
|
*
|
|
6900
7666
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6901
|
-
* via the `definition` "
|
|
7667
|
+
* via the `definition` "ConnectorAuthorizationRequirement".
|
|
6902
7668
|
*/
|
|
6903
7669
|
/** @experimental */
|
|
6904
|
-
export interface
|
|
7670
|
+
export interface ConnectorAuthorizationRequirement {
|
|
6905
7671
|
/**
|
|
6906
|
-
*
|
|
7672
|
+
* Exact opaque account selection that made the Connector request.
|
|
6907
7673
|
*/
|
|
6908
|
-
|
|
7674
|
+
accountId: string;
|
|
7675
|
+
scope: ConnectorAuthorizationScope;
|
|
6909
7676
|
}
|
|
6910
7677
|
/**
|
|
6911
|
-
*
|
|
7678
|
+
* Feature detection and hard polling limits for the EXPERIMENTAL session connector API.
|
|
6912
7679
|
*
|
|
6913
7680
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6914
|
-
* via the `definition` "
|
|
7681
|
+
* via the `definition` "ConnectorCapabilities".
|
|
6915
7682
|
*/
|
|
6916
7683
|
/** @experimental */
|
|
6917
|
-
export interface
|
|
7684
|
+
export interface ConnectorCapabilities {
|
|
6918
7685
|
/**
|
|
6919
|
-
*
|
|
7686
|
+
* Connector API contract version.
|
|
6920
7687
|
*/
|
|
6921
|
-
|
|
7688
|
+
apiVersion: number;
|
|
7689
|
+
availability: ConnectorAvailability;
|
|
6922
7690
|
/**
|
|
6923
|
-
*
|
|
7691
|
+
* Whether connect and reconnect can return an opaque continuation for bounded consent polling.
|
|
6924
7692
|
*/
|
|
6925
|
-
|
|
6926
|
-
}
|
|
6927
|
-
/**
|
|
6928
|
-
* Content-exclusion decision for one requested path.
|
|
6929
|
-
*
|
|
6930
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6931
|
-
* via the `definition` "ContentExclusionPathCheck".
|
|
6932
|
-
*/
|
|
6933
|
-
/** @experimental */
|
|
6934
|
-
export interface ContentExclusionPathCheck {
|
|
7693
|
+
consentContinuation: boolean;
|
|
6935
7694
|
/**
|
|
6936
|
-
*
|
|
7695
|
+
* Whether callers select a host-owned GitHub account through an opaque selection ID rather than supplying a provider token.
|
|
6937
7696
|
*/
|
|
6938
|
-
|
|
7697
|
+
opaqueAccountSelection: boolean;
|
|
6939
7698
|
/**
|
|
6940
|
-
*
|
|
7699
|
+
* Maximum accepted polling attempts for one continuation call.
|
|
6941
7700
|
*/
|
|
6942
|
-
|
|
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;
|
|
6943
7710
|
}
|
|
6944
7711
|
/**
|
|
6945
|
-
*
|
|
7712
|
+
* Credential-free Connector catalog entry.
|
|
6946
7713
|
*
|
|
6947
7714
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6948
|
-
* via the `definition` "
|
|
7715
|
+
* via the `definition` "ConnectorCatalogEntry".
|
|
6949
7716
|
*/
|
|
6950
7717
|
/** @experimental */
|
|
6951
|
-
export interface
|
|
7718
|
+
export interface ConnectorCatalogEntry {
|
|
6952
7719
|
/**
|
|
6953
|
-
*
|
|
7720
|
+
* Canonical Connector name used by lifecycle methods.
|
|
6954
7721
|
*/
|
|
6955
|
-
|
|
7722
|
+
name: string;
|
|
6956
7723
|
/**
|
|
6957
|
-
*
|
|
7724
|
+
* Untrusted display label from the service.
|
|
6958
7725
|
*/
|
|
6959
|
-
|
|
7726
|
+
displayName: string;
|
|
6960
7727
|
/**
|
|
6961
|
-
*
|
|
7728
|
+
* Untrusted service description, when present.
|
|
6962
7729
|
*/
|
|
6963
|
-
|
|
7730
|
+
description?: string;
|
|
7731
|
+
status: ConnectorCatalogStatus;
|
|
6964
7732
|
/**
|
|
6965
|
-
*
|
|
7733
|
+
* Opaque stable runtime IDs currently projected into the session for this Connector.
|
|
6966
7734
|
*/
|
|
6967
|
-
|
|
7735
|
+
runtimeServerIds: string[];
|
|
6968
7736
|
}
|
|
6969
7737
|
/**
|
|
6970
|
-
*
|
|
7738
|
+
* Validated Connector catalog snapshot cached by the session.
|
|
6971
7739
|
*
|
|
6972
7740
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6973
|
-
* via the `definition` "
|
|
7741
|
+
* via the `definition` "ConnectorCatalogResult".
|
|
6974
7742
|
*/
|
|
6975
7743
|
/** @experimental */
|
|
6976
|
-
export interface
|
|
6977
|
-
/**
|
|
6978
|
-
* Currently active model identifier
|
|
6979
|
-
*/
|
|
6980
|
-
modelId?: string;
|
|
7744
|
+
export interface ConnectorCatalogResult {
|
|
6981
7745
|
/**
|
|
6982
|
-
*
|
|
7746
|
+
* Monotonically increasing session-local catalog revision.
|
|
6983
7747
|
*/
|
|
6984
|
-
|
|
6985
|
-
contextTier?: ContextTier;
|
|
6986
|
-
autoTier?: AutoTier;
|
|
7748
|
+
revision: number;
|
|
6987
7749
|
/**
|
|
6988
|
-
*
|
|
7750
|
+
* Unix epoch milliseconds when this snapshot was accepted.
|
|
6989
7751
|
*/
|
|
6990
|
-
|
|
7752
|
+
refreshedAtMs: number;
|
|
6991
7753
|
/**
|
|
6992
|
-
*
|
|
7754
|
+
* Validated catalog entries in service order.
|
|
6993
7755
|
*/
|
|
6994
|
-
|
|
7756
|
+
connectors: ConnectorCatalogEntry[];
|
|
6995
7757
|
}
|
|
6996
7758
|
/**
|
|
6997
|
-
*
|
|
7759
|
+
* Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
|
|
6998
7760
|
*
|
|
6999
7761
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7000
|
-
* via the `definition` "
|
|
7762
|
+
* via the `definition` "ConnectorConnectRequest".
|
|
7001
7763
|
*/
|
|
7002
7764
|
/** @experimental */
|
|
7003
|
-
export interface
|
|
7004
|
-
/**
|
|
7005
|
-
* Model-facing tool name
|
|
7006
|
-
*/
|
|
7007
|
-
name: string;
|
|
7765
|
+
export interface ConnectorConnectRequest {
|
|
7008
7766
|
/**
|
|
7009
|
-
*
|
|
7767
|
+
* Opaque account selection ID. It must match the account already pinned to the session, if any.
|
|
7010
7768
|
*/
|
|
7011
|
-
|
|
7769
|
+
accountId: string;
|
|
7012
7770
|
/**
|
|
7013
|
-
*
|
|
7771
|
+
* Canonical Connector name from the current catalog.
|
|
7014
7772
|
*/
|
|
7015
|
-
|
|
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 {
|
|
7016
7783
|
/**
|
|
7017
|
-
*
|
|
7784
|
+
* Connector API contract version.
|
|
7018
7785
|
*/
|
|
7019
|
-
|
|
7786
|
+
apiVersion: number;
|
|
7787
|
+
availability: ConnectorAvailability;
|
|
7020
7788
|
/**
|
|
7021
|
-
*
|
|
7789
|
+
* Opaque account selection pinned to this session, when one has been selected.
|
|
7022
7790
|
*/
|
|
7023
|
-
|
|
7791
|
+
accountId?: string;
|
|
7792
|
+
catalog?: ConnectorCatalogResult;
|
|
7793
|
+
authorizationRequirement?: ConnectorAuthorizationRequirement;
|
|
7024
7794
|
/**
|
|
7025
|
-
*
|
|
7795
|
+
* Live MCP status for every Connector-owned runtime server.
|
|
7026
7796
|
*/
|
|
7027
|
-
|
|
7028
|
-
[k: string]: JsonValue | undefined;
|
|
7029
|
-
};
|
|
7797
|
+
runtimeServers: ConnectorRuntimeStatus[];
|
|
7030
7798
|
/**
|
|
7031
|
-
*
|
|
7799
|
+
* Number of active opaque connection continuations.
|
|
7032
7800
|
*/
|
|
7033
|
-
|
|
7801
|
+
pendingConnections: number;
|
|
7034
7802
|
}
|
|
7035
7803
|
/**
|
|
7036
|
-
*
|
|
7804
|
+
* Live status of one session-owned MCP projection.
|
|
7037
7805
|
*
|
|
7038
7806
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7039
|
-
* via the `definition` "
|
|
7807
|
+
* via the `definition` "ConnectorRuntimeStatus".
|
|
7040
7808
|
*/
|
|
7041
7809
|
/** @experimental */
|
|
7042
|
-
export interface
|
|
7810
|
+
export interface ConnectorRuntimeStatus {
|
|
7043
7811
|
/**
|
|
7044
|
-
*
|
|
7812
|
+
* Opaque runtime server ID.
|
|
7045
7813
|
*/
|
|
7046
|
-
|
|
7047
|
-
source: DebugCollectLogsSource;
|
|
7814
|
+
runtimeServerId: string;
|
|
7048
7815
|
/**
|
|
7049
|
-
*
|
|
7816
|
+
* Canonical Connector name that owns this server.
|
|
7050
7817
|
*/
|
|
7051
|
-
|
|
7818
|
+
connectorName: string;
|
|
7819
|
+
status: ConnectorMcpStatus;
|
|
7052
7820
|
}
|
|
7053
7821
|
/**
|
|
7054
|
-
*
|
|
7822
|
+
* Explicitly bounded continuation of a pending Connector connection.
|
|
7055
7823
|
*
|
|
7056
7824
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7057
|
-
* via the `definition` "
|
|
7825
|
+
* via the `definition` "ConnectorContinueRequest".
|
|
7058
7826
|
*/
|
|
7059
7827
|
/** @experimental */
|
|
7060
|
-
export interface
|
|
7061
|
-
kind: DebugCollectLogsEntryKind;
|
|
7828
|
+
export interface ConnectorContinueRequest {
|
|
7062
7829
|
/**
|
|
7063
|
-
*
|
|
7830
|
+
* Opaque continuation ID returned by connect, reconnect, or an earlier continuation.
|
|
7064
7831
|
*/
|
|
7065
|
-
|
|
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.
|
|
7922
|
+
*
|
|
7923
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7924
|
+
* via the `definition` "ContentExclusionPathCheck".
|
|
7925
|
+
*/
|
|
7926
|
+
/** @experimental */
|
|
7927
|
+
export interface ContentExclusionPathCheck {
|
|
7928
|
+
/**
|
|
7929
|
+
* The path supplied by the caller.
|
|
7930
|
+
*/
|
|
7931
|
+
path: string;
|
|
7932
|
+
/**
|
|
7933
|
+
* Whether the session's complete content-exclusion policy excludes the path.
|
|
7934
|
+
*/
|
|
7935
|
+
excluded: boolean;
|
|
7936
|
+
}
|
|
7937
|
+
/**
|
|
7938
|
+
* A single large message currently in context.
|
|
7939
|
+
*
|
|
7940
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7941
|
+
* via the `definition` "ContextHeaviestMessage".
|
|
7942
|
+
*/
|
|
7943
|
+
/** @experimental */
|
|
7944
|
+
export interface ContextHeaviestMessage {
|
|
7945
|
+
/**
|
|
7946
|
+
* Stable identifier for this message within the snapshot.
|
|
7947
|
+
*/
|
|
7948
|
+
id: string;
|
|
7949
|
+
/**
|
|
7950
|
+
* Human-readable source label, e.g. `tool: bash` or `skill: tmux`. Presentation-only.
|
|
7951
|
+
*/
|
|
7952
|
+
label: string;
|
|
7953
|
+
/**
|
|
7954
|
+
* Role of the chat message (`user`, `assistant`, or `tool`).
|
|
7955
|
+
*/
|
|
7956
|
+
role: string;
|
|
7957
|
+
/**
|
|
7958
|
+
* Token count currently in context for this individual message.
|
|
7959
|
+
*/
|
|
7960
|
+
tokens: number;
|
|
7961
|
+
}
|
|
7962
|
+
/**
|
|
7963
|
+
* The session's authoritative model snapshot. Auto preference fields are configuration for the virtual `auto` model and do not change the selected model identifier. The context tier reflects `Session.getContextTier()`, restored from the session journal on resume.
|
|
7964
|
+
*
|
|
7965
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7966
|
+
* via the `definition` "CurrentModel".
|
|
7967
|
+
*/
|
|
7968
|
+
/** @experimental */
|
|
7969
|
+
export interface CurrentModel {
|
|
7970
|
+
/**
|
|
7971
|
+
* Currently active model identifier
|
|
7972
|
+
*/
|
|
7973
|
+
modelId?: string;
|
|
7974
|
+
/**
|
|
7975
|
+
* Reasoning effort level currently applied to the active model, when one is set. Reads `Session.getReasoningEffort()` synchronously after `getSelectedModel()` resolves so the two values are reported as a snapshot.
|
|
7976
|
+
*/
|
|
7977
|
+
reasoningEffort?: string;
|
|
7978
|
+
contextTier?: ContextTier;
|
|
7979
|
+
autoTier?: AutoTier;
|
|
7980
|
+
/**
|
|
7981
|
+
* Latest unclaimed Auto preference waiting for a future user turn. Null means the pending request is returning to provider-default routing.
|
|
7982
|
+
*/
|
|
7983
|
+
pendingAutoTier?: AutoTier | null;
|
|
7984
|
+
/**
|
|
7985
|
+
* Auto preference currently claimed by an in-progress activation. Null means the activation is returning to provider-default routing.
|
|
7986
|
+
*/
|
|
7987
|
+
activatingAutoTier?: AutoTier | null;
|
|
7988
|
+
}
|
|
7989
|
+
/**
|
|
7990
|
+
* Lightweight metadata for a currently initialized session tool
|
|
7991
|
+
*
|
|
7992
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7993
|
+
* via the `definition` "CurrentToolMetadata".
|
|
7994
|
+
*/
|
|
7995
|
+
/** @experimental */
|
|
7996
|
+
export interface CurrentToolMetadata {
|
|
7997
|
+
/**
|
|
7998
|
+
* Model-facing tool name
|
|
7999
|
+
*/
|
|
8000
|
+
name: string;
|
|
8001
|
+
/**
|
|
8002
|
+
* Optional MCP/config namespaced tool name
|
|
8003
|
+
*/
|
|
8004
|
+
namespacedName?: string;
|
|
8005
|
+
/**
|
|
8006
|
+
* MCP server name for MCP-backed tools
|
|
8007
|
+
*/
|
|
8008
|
+
mcpServerName?: string;
|
|
8009
|
+
/**
|
|
8010
|
+
* Raw MCP tool name for MCP-backed tools
|
|
8011
|
+
*/
|
|
8012
|
+
mcpToolName?: string;
|
|
8013
|
+
/**
|
|
8014
|
+
* Tool description
|
|
8015
|
+
*/
|
|
8016
|
+
description: string;
|
|
8017
|
+
/**
|
|
8018
|
+
* JSON Schema for tool input
|
|
8019
|
+
*/
|
|
8020
|
+
input_schema?: {
|
|
8021
|
+
[k: string]: JsonValue | undefined;
|
|
8022
|
+
};
|
|
8023
|
+
/**
|
|
8024
|
+
* Whether the tool is loaded on demand via tool search
|
|
8025
|
+
*/
|
|
8026
|
+
deferLoading?: boolean;
|
|
8027
|
+
}
|
|
8028
|
+
/**
|
|
8029
|
+
* A file included in the session debug bundle.
|
|
8030
|
+
*
|
|
8031
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
8032
|
+
* via the `definition` "DebugCollectLogsCollectedEntry".
|
|
8033
|
+
*/
|
|
8034
|
+
/** @experimental */
|
|
8035
|
+
export interface DebugCollectLogsCollectedEntry {
|
|
8036
|
+
/**
|
|
8037
|
+
* Relative path of the file in the staged bundle/archive.
|
|
8038
|
+
*/
|
|
8039
|
+
bundlePath: string;
|
|
8040
|
+
source: DebugCollectLogsSource;
|
|
8041
|
+
/**
|
|
8042
|
+
* Redacted output size in bytes.
|
|
8043
|
+
*/
|
|
8044
|
+
sizeBytes: number;
|
|
8045
|
+
}
|
|
8046
|
+
/**
|
|
8047
|
+
* A caller-provided server-local file or directory to include in the debug bundle.
|
|
8048
|
+
*
|
|
8049
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
8050
|
+
* via the `definition` "DebugCollectLogsEntry".
|
|
8051
|
+
*/
|
|
8052
|
+
/** @experimental */
|
|
8053
|
+
export interface DebugCollectLogsEntry {
|
|
8054
|
+
kind: DebugCollectLogsEntryKind;
|
|
8055
|
+
/**
|
|
8056
|
+
* Server-local source path to read.
|
|
8057
|
+
*/
|
|
8058
|
+
path: string;
|
|
7066
8059
|
/**
|
|
7067
8060
|
* Relative path to use inside the staged bundle/archive.
|
|
7068
8061
|
*/
|
|
@@ -7385,18 +8378,16 @@ export interface EnqueueCommandParams {
|
|
|
7385
8378
|
*/
|
|
7386
8379
|
displayText?: string | null;
|
|
7387
8380
|
}
|
|
7388
|
-
/**
|
|
7389
|
-
* Indicates whether the command was accepted into the local execution queue.
|
|
7390
|
-
*
|
|
7391
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7392
|
-
* via the `definition` "EnqueueCommandResult".
|
|
7393
|
-
*/
|
|
7394
8381
|
/** @experimental */
|
|
7395
|
-
export interface
|
|
8382
|
+
export interface UnsupportedEnqueueCommandResult {
|
|
7396
8383
|
/**
|
|
7397
|
-
*
|
|
8384
|
+
* False because the target session does not support local command queueing (e.g. remote sessions).
|
|
7398
8385
|
*/
|
|
7399
|
-
queued:
|
|
8386
|
+
queued: false;
|
|
8387
|
+
/**
|
|
8388
|
+
* Legacy null queue ID accepted for compatibility with older runtimes.
|
|
8389
|
+
*/
|
|
8390
|
+
queueId?: null;
|
|
7400
8391
|
}
|
|
7401
8392
|
/**
|
|
7402
8393
|
* Cursor, batch size, and optional long-poll/filter parameters for reading session events.
|
|
@@ -9656,6 +10647,18 @@ export interface InstalledPluginInfo {
|
|
|
9656
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.
|
|
9657
10648
|
*/
|
|
9658
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;
|
|
9659
10662
|
}
|
|
9660
10663
|
/**
|
|
9661
10664
|
* Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path.
|
|
@@ -10291,6 +11294,14 @@ export interface MarketplaceInfo {
|
|
|
10291
11294
|
* True when this is a default marketplace shipped with the runtime. Defaults are not removable.
|
|
10292
11295
|
*/
|
|
10293
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;
|
|
10294
11305
|
}
|
|
10295
11306
|
/**
|
|
10296
11307
|
* All registered marketplaces, including built-in defaults.
|
|
@@ -10707,6 +11718,10 @@ export interface McpServerConfigStdio {
|
|
|
10707
11718
|
* Timeout in milliseconds for tool discovery and tool calls.
|
|
10708
11719
|
*/
|
|
10709
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;
|
|
10710
11725
|
oidc?: McpServerAuthConfig;
|
|
10711
11726
|
auth?: McpServerAuthConfig;
|
|
10712
11727
|
deferTools?: McpServerConfigDeferTools;
|
|
@@ -10828,6 +11843,10 @@ export interface McpServerConfigHttp {
|
|
|
10828
11843
|
* Timeout in milliseconds for tool discovery and tool calls.
|
|
10829
11844
|
*/
|
|
10830
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;
|
|
10831
11850
|
oidc?: McpServerAuthConfig;
|
|
10832
11851
|
auth?: McpServerAuthConfig;
|
|
10833
11852
|
deferTools?: McpServerConfigDeferTools;
|
|
@@ -11252,7 +12271,7 @@ export interface McpInstallPlan {
|
|
|
11252
12271
|
target: McpPlanTarget;
|
|
11253
12272
|
policy: McpPlanPolicyResult;
|
|
11254
12273
|
/**
|
|
11255
|
-
*
|
|
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.
|
|
11256
12275
|
*/
|
|
11257
12276
|
configurationChanges: McpPlanConfigurationChange[];
|
|
11258
12277
|
/**
|
|
@@ -11260,7 +12279,7 @@ export interface McpInstallPlan {
|
|
|
11260
12279
|
*/
|
|
11261
12280
|
reloadRequired: boolean;
|
|
11262
12281
|
/**
|
|
11263
|
-
*
|
|
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.
|
|
11264
12283
|
*/
|
|
11265
12284
|
requiresInteractiveConfiguration: boolean;
|
|
11266
12285
|
}
|
|
@@ -11492,7 +12511,7 @@ export interface McpPlanPolicyResult {
|
|
|
11492
12511
|
reason?: string;
|
|
11493
12512
|
}
|
|
11494
12513
|
/**
|
|
11495
|
-
*
|
|
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.
|
|
11496
12515
|
*
|
|
11497
12516
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11498
12517
|
* via the `definition` "McpPlanConfigurationChange".
|
|
@@ -11776,7 +12795,7 @@ export interface McpPlanInstallSourceCandidate {
|
|
|
11776
12795
|
*/
|
|
11777
12796
|
candidateHandle: string;
|
|
11778
12797
|
/**
|
|
11779
|
-
* 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.
|
|
11780
12799
|
*/
|
|
11781
12800
|
searchId: string;
|
|
11782
12801
|
}
|
|
@@ -12630,6 +13649,10 @@ export interface ModelCapabilitiesSupports {
|
|
|
12630
13649
|
* Whether this model supports vision/image input
|
|
12631
13650
|
*/
|
|
12632
13651
|
vision?: boolean;
|
|
13652
|
+
/**
|
|
13653
|
+
* Whether this model supports canonical tool calling
|
|
13654
|
+
*/
|
|
13655
|
+
toolCalls?: boolean;
|
|
12633
13656
|
/**
|
|
12634
13657
|
* Whether this model supports reasoning effort configuration
|
|
12635
13658
|
*/
|
|
@@ -12882,6 +13905,7 @@ export interface ModelApplyStartupOverlayRequest {
|
|
|
12882
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.
|
|
12883
13906
|
*/
|
|
12884
13907
|
policyHelperModel?: string;
|
|
13908
|
+
autoTier?: AutoTier;
|
|
12885
13909
|
/**
|
|
12886
13910
|
* Model selected by repository settings, when configured.
|
|
12887
13911
|
*/
|
|
@@ -12930,6 +13954,10 @@ export interface ModelCapabilitiesOverrideSupports {
|
|
|
12930
13954
|
* Whether this model supports vision/image input
|
|
12931
13955
|
*/
|
|
12932
13956
|
vision?: boolean;
|
|
13957
|
+
/**
|
|
13958
|
+
* Whether this model supports canonical tool calling
|
|
13959
|
+
*/
|
|
13960
|
+
toolCalls?: boolean;
|
|
12933
13961
|
/**
|
|
12934
13962
|
* Whether this model supports reasoning effort configuration
|
|
12935
13963
|
*/
|
|
@@ -13169,9 +14197,9 @@ export interface ModelSwitchToRequest {
|
|
|
13169
14197
|
*/
|
|
13170
14198
|
autoTier?: AutoTier | null;
|
|
13171
14199
|
/**
|
|
13172
|
-
* 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.
|
|
13173
14201
|
*/
|
|
13174
|
-
reasoningEffort?: string;
|
|
14202
|
+
reasoningEffort?: string | null;
|
|
13175
14203
|
reasoningSummary?: ReasoningSummary;
|
|
13176
14204
|
verbosity?: Verbosity;
|
|
13177
14205
|
modelCapabilities?: ModelCapabilitiesOverride;
|
|
@@ -13211,6 +14239,10 @@ export interface ModelSwitchToRequest {
|
|
|
13211
14239
|
*/
|
|
13212
14240
|
/** @experimental */
|
|
13213
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;
|
|
13214
14246
|
/**
|
|
13215
14247
|
* Currently active model identifier after the switch
|
|
13216
14248
|
*/
|
|
@@ -13519,6 +14551,10 @@ export interface PendingPermissionRequest {
|
|
|
13519
14551
|
*/
|
|
13520
14552
|
requestId: string;
|
|
13521
14553
|
request: PermissionPromptRequest;
|
|
14554
|
+
/**
|
|
14555
|
+
* Permission-recovery episode that authorized this request to surface for interactive attention
|
|
14556
|
+
*/
|
|
14557
|
+
recoveryEpisodeId?: string;
|
|
13522
14558
|
}
|
|
13523
14559
|
/**
|
|
13524
14560
|
* List of pending permission requests reconstructed from event history.
|
|
@@ -14520,7 +15556,7 @@ export interface PermissionPathsConfig {
|
|
|
14520
15556
|
workspacePath?: string;
|
|
14521
15557
|
}
|
|
14522
15558
|
/**
|
|
14523
|
-
* Snapshot of the session's
|
|
15559
|
+
* Snapshot of the session's recursive directory grants, exact session-approved paths, and primary working directory.
|
|
14524
15560
|
*
|
|
14525
15561
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14526
15562
|
* via the `definition` "PermissionPathsList".
|
|
@@ -14531,6 +15567,10 @@ export interface PermissionPathsList {
|
|
|
14531
15567
|
* All directories currently allowed for tool access on this session.
|
|
14532
15568
|
*/
|
|
14533
15569
|
directories: string[];
|
|
15570
|
+
/**
|
|
15571
|
+
* Exact paths approved for this session without recursively allowing their descendants.
|
|
15572
|
+
*/
|
|
15573
|
+
sessionApprovedPaths?: string[];
|
|
14534
15574
|
/**
|
|
14535
15575
|
* The primary working directory for this session.
|
|
14536
15576
|
*/
|
|
@@ -14836,7 +15876,7 @@ export interface PermissionsPathsAddResult {
|
|
|
14836
15876
|
success: boolean;
|
|
14837
15877
|
}
|
|
14838
15878
|
/**
|
|
14839
|
-
* No parameters; returns the session's
|
|
15879
|
+
* No parameters; returns the session's recursive directory grants and exact session-approved paths.
|
|
14840
15880
|
*
|
|
14841
15881
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14842
15882
|
* via the `definition` "PermissionsPathsListRequest".
|
|
@@ -14867,7 +15907,7 @@ export interface PermissionsPathsUpdatePrimaryResult {
|
|
|
14867
15907
|
export interface PermissionsPendingRequestsRequest {
|
|
14868
15908
|
}
|
|
14869
15909
|
/**
|
|
14870
|
-
* Clears session-scoped tool
|
|
15910
|
+
* Clears session-scoped tool approvals and optionally clears location-scoped approvals and exact session-approved paths.
|
|
14871
15911
|
*
|
|
14872
15912
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
14873
15913
|
* via the `definition` "PermissionsResetSessionApprovalsRequest".
|
|
@@ -14875,7 +15915,7 @@ export interface PermissionsPendingRequestsRequest {
|
|
|
14875
15915
|
/** @experimental */
|
|
14876
15916
|
export interface PermissionsResetSessionApprovalsRequest {
|
|
14877
15917
|
/**
|
|
14878
|
-
* 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`.
|
|
14879
15919
|
*/
|
|
14880
15920
|
includeLocation?: boolean;
|
|
14881
15921
|
}
|
|
@@ -15168,21 +16208,45 @@ export interface Plugin {
|
|
|
15168
16208
|
* Whether the plugin is currently enabled
|
|
15169
16209
|
*/
|
|
15170
16210
|
enabled: boolean;
|
|
15171
|
-
}
|
|
15172
|
-
/**
|
|
15173
|
-
* Result of installing a plugin.
|
|
15174
|
-
*
|
|
15175
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
15176
|
-
* via the `definition` "PluginInstallResult".
|
|
15177
|
-
*/
|
|
15178
|
-
/** @experimental */
|
|
15179
|
-
export interface PluginInstallResult {
|
|
15180
|
-
plugin: InstalledPluginInfo;
|
|
15181
16211
|
/**
|
|
15182
|
-
*
|
|
16212
|
+
* Opaque stable identity for a direct plugin source.
|
|
15183
16213
|
*/
|
|
15184
|
-
|
|
15185
|
-
|
|
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;
|
|
16235
|
+
}
|
|
16236
|
+
/**
|
|
16237
|
+
* Result of installing a plugin.
|
|
16238
|
+
*
|
|
16239
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
16240
|
+
* via the `definition` "PluginInstallResult".
|
|
16241
|
+
*/
|
|
16242
|
+
/** @experimental */
|
|
16243
|
+
export interface PluginInstallResult {
|
|
16244
|
+
plugin: InstalledPluginInfo;
|
|
16245
|
+
/**
|
|
16246
|
+
* Number of skills discovered and installed from the plugin
|
|
16247
|
+
*/
|
|
16248
|
+
skillsInstalled: number;
|
|
16249
|
+
stagingMode?: PluginInstallStagingMode;
|
|
15186
16250
|
/**
|
|
15187
16251
|
* Optional post-install message provided by the plugin (e.g. setup instructions)
|
|
15188
16252
|
*/
|
|
@@ -15523,6 +16587,10 @@ export interface SystemMessageBlock {
|
|
|
15523
16587
|
* Whether the block is static and may be cached independently of dynamic prompt content.
|
|
15524
16588
|
*/
|
|
15525
16589
|
isStatic?: boolean;
|
|
16590
|
+
/**
|
|
16591
|
+
* Whether providers with explicit prompt caching should place a cache breakpoint after this block.
|
|
16592
|
+
*/
|
|
16593
|
+
cacheBreakpoint?: boolean;
|
|
15526
16594
|
}
|
|
15527
16595
|
/** @experimental */
|
|
15528
16596
|
export interface ProtocolSystemMessageCustomizeConfig {
|
|
@@ -15597,6 +16665,12 @@ export interface ProviderModelConfig {
|
|
|
15597
16665
|
maxOutputTokens?: number;
|
|
15598
16666
|
capabilities?: ModelCapabilitiesOverride;
|
|
15599
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
|
+
};
|
|
15600
16674
|
}
|
|
15601
16675
|
/**
|
|
15602
16676
|
* The selectable model entries synthesized for the models added by this call.
|
|
@@ -15723,6 +16797,44 @@ export interface ProviderSessionToken {
|
|
|
15723
16797
|
*/
|
|
15724
16798
|
expiresAt?: string;
|
|
15725
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
|
+
}
|
|
15726
16838
|
/**
|
|
15727
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.
|
|
15728
16840
|
*
|
|
@@ -16212,6 +17324,36 @@ export interface PushAttachmentBlob {
|
|
|
16212
17324
|
*/
|
|
16213
17325
|
displayName?: string;
|
|
16214
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
|
+
}
|
|
16215
17357
|
/**
|
|
16216
17358
|
* Inputs for starting a deferred-idle drain.
|
|
16217
17359
|
*
|
|
@@ -16590,6 +17732,10 @@ export interface QueueSetDrainPausedRequest {
|
|
|
16590
17732
|
*/
|
|
16591
17733
|
/** @experimental */
|
|
16592
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;
|
|
16593
17739
|
/**
|
|
16594
17740
|
* User-facing pending items in FIFO order.
|
|
16595
17741
|
*/
|
|
@@ -16641,6 +17787,23 @@ export interface QueueUpdateTextResult {
|
|
|
16641
17787
|
*/
|
|
16642
17788
|
updated: boolean;
|
|
16643
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
|
+
}
|
|
16644
17807
|
/**
|
|
16645
17808
|
* Event type to register consumer interest for, used by runtime gating logic.
|
|
16646
17809
|
*
|
|
@@ -18134,7 +19297,7 @@ export interface SessionFsSetProviderCapabilities {
|
|
|
18134
19297
|
sqlite?: boolean;
|
|
18135
19298
|
}
|
|
18136
19299
|
/**
|
|
18137
|
-
* 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.
|
|
18138
19301
|
*
|
|
18139
19302
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
18140
19303
|
* via the `definition` "SessionFsSetProviderRequest".
|
|
@@ -18142,7 +19305,7 @@ export interface SessionFsSetProviderCapabilities {
|
|
|
18142
19305
|
/** @experimental */
|
|
18143
19306
|
export interface SessionFsSetProviderRequest {
|
|
18144
19307
|
/**
|
|
18145
|
-
*
|
|
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.
|
|
18146
19309
|
*/
|
|
18147
19310
|
initialCwd: string;
|
|
18148
19311
|
/**
|
|
@@ -18612,7 +19775,7 @@ export interface SessionLoadDeferredRepoHooksResult {
|
|
|
18612
19775
|
/** @experimental */
|
|
18613
19776
|
export interface SessionManagedPermissions {
|
|
18614
19777
|
/**
|
|
18615
|
-
* 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.
|
|
18616
19779
|
*/
|
|
18617
19780
|
disableBypassPermissionsMode?: string;
|
|
18618
19781
|
/**
|
|
@@ -18696,6 +19859,7 @@ export interface SessionMetadataSnapshot {
|
|
|
18696
19859
|
* Current session limits, or null when no limits are active
|
|
18697
19860
|
*/
|
|
18698
19861
|
sessionLimits: SessionLimitsConfig | null;
|
|
19862
|
+
indexedSearch?: IndexedSearchState;
|
|
18699
19863
|
/**
|
|
18700
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).
|
|
18701
19865
|
*/
|
|
@@ -18903,6 +20067,10 @@ export interface SessionOpenOptions {
|
|
|
18903
20067
|
* Additional directories to search for skills.
|
|
18904
20068
|
*/
|
|
18905
20069
|
skillDirectories?: string[];
|
|
20070
|
+
/**
|
|
20071
|
+
* Skill scan directories and descendants excluded from discovery. Supports `~`-relative paths.
|
|
20072
|
+
*/
|
|
20073
|
+
ignoredSkillsLocations?: string[];
|
|
18906
20074
|
/**
|
|
18907
20075
|
* Whether skill loading is enabled. When omitted, an SDK skill provider enables skills by default.
|
|
18908
20076
|
*/
|
|
@@ -19328,6 +20496,45 @@ export interface SessionsOpenProgress {
|
|
|
19328
20496
|
*/
|
|
19329
20497
|
message?: string;
|
|
19330
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
|
+
}
|
|
19331
20538
|
/**
|
|
19332
20539
|
* Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag.
|
|
19333
20540
|
*
|
|
@@ -20344,6 +21551,10 @@ export interface SessionUpdateOptionsParams {
|
|
|
20344
21551
|
* Additional directories to search for skills.
|
|
20345
21552
|
*/
|
|
20346
21553
|
skillDirectories?: string[];
|
|
21554
|
+
/**
|
|
21555
|
+
* Skill scan directories and descendants excluded from discovery. Supports `~`-relative paths.
|
|
21556
|
+
*/
|
|
21557
|
+
ignoredSkillsLocations?: string[];
|
|
20347
21558
|
/**
|
|
20348
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.
|
|
20349
21560
|
*/
|
|
@@ -20772,6 +21983,10 @@ export interface SkillsDiscoverRequest {
|
|
|
20772
21983
|
* Optional list of additional skill directory paths to include
|
|
20773
21984
|
*/
|
|
20774
21985
|
skillDirectories?: string[];
|
|
21986
|
+
/**
|
|
21987
|
+
* Optional skill scan paths to exclude from discovery.
|
|
21988
|
+
*/
|
|
21989
|
+
ignoredSkillsLocations?: string[];
|
|
20775
21990
|
/**
|
|
20776
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.
|
|
20777
21992
|
*/
|
|
@@ -20802,6 +22017,10 @@ export interface SkillsGetDiscoveryPathsRequest {
|
|
|
20802
22017
|
* Optional list of project directory paths. When omitted or empty, only personal and custom directories are returned.
|
|
20803
22018
|
*/
|
|
20804
22019
|
projectPaths?: string[];
|
|
22020
|
+
/**
|
|
22021
|
+
* Optional skill scan paths to exclude from discovery.
|
|
22022
|
+
*/
|
|
22023
|
+
ignoredSkillsLocations?: string[];
|
|
20805
22024
|
/**
|
|
20806
22025
|
* When true, omit the host's personal and custom skill directories, leaving only project directories. For multitenant deployments.
|
|
20807
22026
|
*/
|
|
@@ -21875,6 +23094,12 @@ export interface Tool {
|
|
|
21875
23094
|
* Optional instructions for how to use this tool effectively
|
|
21876
23095
|
*/
|
|
21877
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;
|
|
21878
23103
|
}
|
|
21879
23104
|
/**
|
|
21880
23105
|
* Built-in tools available for the requested model, with their parameters and instructions.
|
|
@@ -23052,83 +24277,1046 @@ export interface UserSettingMetadata {
|
|
|
23052
24277
|
/** @experimental */
|
|
23053
24278
|
export interface UserSettingsGetResult {
|
|
23054
24279
|
/**
|
|
23055
|
-
* Every known user setting keyed by setting name, each with its effective value, default, and whether it is at the default.
|
|
24280
|
+
* Every known user setting keyed by setting name, each with its effective value, default, and whether it is at the default.
|
|
24281
|
+
*/
|
|
24282
|
+
settings: {
|
|
24283
|
+
[k: string]: UserSettingMetadata;
|
|
24284
|
+
};
|
|
24285
|
+
}
|
|
24286
|
+
/**
|
|
24287
|
+
* Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed.
|
|
24288
|
+
*
|
|
24289
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24290
|
+
* via the `definition` "UserSettingsSetRequest".
|
|
24291
|
+
*/
|
|
24292
|
+
/** @experimental */
|
|
24293
|
+
export interface UserSettingsSetRequest {
|
|
24294
|
+
/**
|
|
24295
|
+
* Partial user settings to write, as a free-form object keyed by setting name
|
|
24296
|
+
*/
|
|
24297
|
+
settings: JsonValue;
|
|
24298
|
+
}
|
|
24299
|
+
/**
|
|
24300
|
+
* Outcome of writing user settings.
|
|
24301
|
+
*
|
|
24302
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24303
|
+
* via the `definition` "UserSettingsSetResult".
|
|
24304
|
+
*/
|
|
24305
|
+
/** @experimental */
|
|
24306
|
+
export interface UserSettingsSetResult {
|
|
24307
|
+
/**
|
|
24308
|
+
* Top-level keys whose write landed in settings.json but is shadowed by a value still present in the legacy config.json (config.json wins on read). The write does not take effect until the legacy value is removed.
|
|
24309
|
+
*/
|
|
24310
|
+
shadowedKeys: string[];
|
|
24311
|
+
}
|
|
24312
|
+
/**
|
|
24313
|
+
* Current sharing status and shareable GitHub URL for a session.
|
|
24314
|
+
*
|
|
24315
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24316
|
+
* via the `definition` "VisibilityGetResult".
|
|
24317
|
+
*/
|
|
24318
|
+
/** @experimental */
|
|
24319
|
+
export interface VisibilityGetResult {
|
|
24320
|
+
/**
|
|
24321
|
+
* Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the session cannot be shared and `status`/`shareUrl` are absent.
|
|
24322
|
+
*/
|
|
24323
|
+
synced: boolean;
|
|
24324
|
+
status?: SessionVisibilityStatus;
|
|
24325
|
+
/**
|
|
24326
|
+
* Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved.
|
|
24327
|
+
*/
|
|
24328
|
+
shareUrl?: string;
|
|
24329
|
+
}
|
|
24330
|
+
/**
|
|
24331
|
+
* Desired sharing status for the session.
|
|
24332
|
+
*
|
|
24333
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24334
|
+
* via the `definition` "VisibilitySetRequest".
|
|
24335
|
+
*/
|
|
24336
|
+
/** @experimental */
|
|
24337
|
+
export interface VisibilitySetRequest {
|
|
24338
|
+
status: SessionVisibilityStatus;
|
|
24339
|
+
}
|
|
24340
|
+
/**
|
|
24341
|
+
* Effective sharing status and shareable GitHub URL after updating session visibility.
|
|
24342
|
+
*
|
|
24343
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24344
|
+
* via the `definition` "VisibilitySetResult".
|
|
24345
|
+
*/
|
|
24346
|
+
/** @experimental */
|
|
24347
|
+
export interface VisibilitySetResult {
|
|
24348
|
+
/**
|
|
24349
|
+
* Whether the session has been synced to Mission Control (i.e. has a GitHub task). When false, the visibility change could not be applied and `status`/`shareUrl` are absent.
|
|
24350
|
+
*/
|
|
24351
|
+
synced: boolean;
|
|
24352
|
+
status?: SessionVisibilityStatus;
|
|
24353
|
+
/**
|
|
24354
|
+
* Shareable GitHub URL for the session. Present when the session is synced and the URL can be resolved.
|
|
24355
|
+
*/
|
|
24356
|
+
shareUrl?: string;
|
|
24357
|
+
}
|
|
24358
|
+
/**
|
|
24359
|
+
* Parameters for cooperatively aborting a workflow body.
|
|
24360
|
+
*
|
|
24361
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24362
|
+
* via the `definition` "WorkflowAbortRequest".
|
|
24363
|
+
*/
|
|
24364
|
+
/** @experimental */
|
|
24365
|
+
export interface WorkflowAbortRequest {
|
|
24366
|
+
/**
|
|
24367
|
+
* Target session identifier
|
|
24368
|
+
*/
|
|
24369
|
+
sessionId: string;
|
|
24370
|
+
/**
|
|
24371
|
+
* Workflow run identifier.
|
|
24372
|
+
*/
|
|
24373
|
+
runId: string;
|
|
24374
|
+
/**
|
|
24375
|
+
* Opaque token identifying the execution attempt to abort.
|
|
24376
|
+
*/
|
|
24377
|
+
executionToken: string;
|
|
24378
|
+
}
|
|
24379
|
+
/**
|
|
24380
|
+
* Acknowledgement that a workflow request was accepted.
|
|
24381
|
+
*
|
|
24382
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24383
|
+
* via the `definition` "WorkflowAckResult".
|
|
24384
|
+
*/
|
|
24385
|
+
/** @experimental */
|
|
24386
|
+
export interface WorkflowAckResult {
|
|
24387
|
+
}
|
|
24388
|
+
/**
|
|
24389
|
+
* Options for one workflow-scoped subagent call.
|
|
24390
|
+
*
|
|
24391
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24392
|
+
* via the `definition` "WorkflowAgentOptions".
|
|
24393
|
+
*/
|
|
24394
|
+
/** @experimental */
|
|
24395
|
+
export interface WorkflowAgentOptions {
|
|
24396
|
+
/**
|
|
24397
|
+
* Optional label distinguishing otherwise identical memoized agent calls.
|
|
24398
|
+
*/
|
|
24399
|
+
label?: string;
|
|
24400
|
+
/**
|
|
24401
|
+
* Optional JSON Schema for structured agent output.
|
|
24402
|
+
*/
|
|
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;
|
|
24417
|
+
}
|
|
24418
|
+
/**
|
|
24419
|
+
* Parameters for one workflow-scoped subagent call.
|
|
24420
|
+
*
|
|
24421
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24422
|
+
* via the `definition` "WorkflowAgentRequest".
|
|
24423
|
+
*/
|
|
24424
|
+
/** @experimental */
|
|
24425
|
+
export interface WorkflowAgentRequest {
|
|
24426
|
+
/**
|
|
24427
|
+
* Workflow run identifier that owns the subagent.
|
|
24428
|
+
*/
|
|
24429
|
+
workflowRunId: string;
|
|
24430
|
+
/**
|
|
24431
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
24432
|
+
*/
|
|
24433
|
+
executionToken: string;
|
|
24434
|
+
/**
|
|
24435
|
+
* Prompt to send to the subagent.
|
|
24436
|
+
*/
|
|
24437
|
+
prompt: string;
|
|
24438
|
+
opts: WorkflowAgentOptions;
|
|
24439
|
+
}
|
|
24440
|
+
/**
|
|
24441
|
+
* Result of one workflow-scoped subagent call.
|
|
24442
|
+
*
|
|
24443
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24444
|
+
* via the `definition` "WorkflowAgentResult".
|
|
24445
|
+
*/
|
|
24446
|
+
/** @experimental */
|
|
24447
|
+
export interface WorkflowAgentResult {
|
|
24448
|
+
/**
|
|
24449
|
+
* Agent result, omitted when the agent produced no result.
|
|
24450
|
+
*/
|
|
24451
|
+
result?: JsonValue;
|
|
24452
|
+
}
|
|
24453
|
+
/**
|
|
24454
|
+
* Prompt-safe durable identity and live status for a direct workflow agent.
|
|
24455
|
+
*
|
|
24456
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24457
|
+
* via the `definition` "WorkflowAgentSummary".
|
|
24458
|
+
*/
|
|
24459
|
+
/** @experimental */
|
|
24460
|
+
export interface WorkflowAgentSummary {
|
|
24461
|
+
/**
|
|
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.
|
|
23056
25265
|
*/
|
|
23057
|
-
|
|
23058
|
-
[k: string]: UserSettingMetadata;
|
|
23059
|
-
};
|
|
23060
|
-
}
|
|
23061
|
-
/**
|
|
23062
|
-
* Partial user settings to write to settings.json. Each top-level key is written individually, replacing the existing value; a key whose value is null is removed.
|
|
23063
|
-
*
|
|
23064
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23065
|
-
* via the `definition` "UserSettingsSetRequest".
|
|
23066
|
-
*/
|
|
23067
|
-
/** @experimental */
|
|
23068
|
-
export interface UserSettingsSetRequest {
|
|
25266
|
+
terminal: WorkflowRunTerminal | null;
|
|
23069
25267
|
/**
|
|
23070
|
-
*
|
|
25268
|
+
* Whether the durable run state currently passes runtime resume eligibility checks.
|
|
23071
25269
|
*/
|
|
23072
|
-
|
|
23073
|
-
}
|
|
23074
|
-
/**
|
|
23075
|
-
* Outcome of writing user settings.
|
|
23076
|
-
*
|
|
23077
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23078
|
-
* via the `definition` "UserSettingsSetResult".
|
|
23079
|
-
*/
|
|
23080
|
-
/** @experimental */
|
|
23081
|
-
export interface UserSettingsSetResult {
|
|
25270
|
+
canResume: boolean;
|
|
23082
25271
|
/**
|
|
23083
|
-
*
|
|
25272
|
+
* Lifecycle and timing observations for each workflow phase.
|
|
23084
25273
|
*/
|
|
23085
|
-
|
|
25274
|
+
phases: WorkflowPhaseObservation[];
|
|
25275
|
+
/**
|
|
25276
|
+
* Durable identities and live statuses for direct workflow agents.
|
|
25277
|
+
*/
|
|
25278
|
+
agents: WorkflowAgentSummary[];
|
|
25279
|
+
progress: WorkflowProgressPage;
|
|
23086
25280
|
}
|
|
23087
25281
|
/**
|
|
23088
|
-
*
|
|
25282
|
+
* Options controlling workflow invocation.
|
|
23089
25283
|
*
|
|
23090
25284
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23091
|
-
* via the `definition` "
|
|
25285
|
+
* via the `definition` "WorkflowRunOptions".
|
|
23092
25286
|
*/
|
|
23093
25287
|
/** @experimental */
|
|
23094
|
-
export interface
|
|
25288
|
+
export interface WorkflowRunOptions {
|
|
25289
|
+
limits?: WorkflowRunLimits;
|
|
23095
25290
|
/**
|
|
23096
|
-
* Whether
|
|
25291
|
+
* Whether to notify the originating session when the workflow completes.
|
|
23097
25292
|
*/
|
|
23098
|
-
|
|
23099
|
-
status?: SessionVisibilityStatus;
|
|
25293
|
+
notifyOnComplete?: boolean;
|
|
23100
25294
|
/**
|
|
23101
|
-
*
|
|
25295
|
+
* Whether to emit workflow phase names to the session transcript.
|
|
23102
25296
|
*/
|
|
23103
|
-
|
|
23104
|
-
|
|
23105
|
-
|
|
23106
|
-
|
|
23107
|
-
|
|
23108
|
-
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23109
|
-
* via the `definition` "VisibilitySetRequest".
|
|
23110
|
-
*/
|
|
23111
|
-
/** @experimental */
|
|
23112
|
-
export interface VisibilitySetRequest {
|
|
23113
|
-
status: SessionVisibilityStatus;
|
|
25297
|
+
logPhaseNames?: boolean;
|
|
25298
|
+
/**
|
|
25299
|
+
* Run identifier whose journal and progress should seed this resumed run.
|
|
25300
|
+
*/
|
|
25301
|
+
resumeFromRunId?: string;
|
|
23114
25302
|
}
|
|
23115
25303
|
/**
|
|
23116
|
-
*
|
|
25304
|
+
* Parameters for invoking a registered workflow.
|
|
23117
25305
|
*
|
|
23118
25306
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23119
|
-
* via the `definition` "
|
|
25307
|
+
* via the `definition` "WorkflowRunRequest".
|
|
23120
25308
|
*/
|
|
23121
25309
|
/** @experimental */
|
|
23122
|
-
export interface
|
|
25310
|
+
export interface WorkflowRunRequest {
|
|
23123
25311
|
/**
|
|
23124
|
-
*
|
|
25312
|
+
* Registered workflow name.
|
|
23125
25313
|
*/
|
|
23126
|
-
|
|
23127
|
-
status?: SessionVisibilityStatus;
|
|
25314
|
+
name: string;
|
|
23128
25315
|
/**
|
|
23129
|
-
*
|
|
25316
|
+
* Workflow input value.
|
|
23130
25317
|
*/
|
|
23131
|
-
|
|
25318
|
+
args: JsonValue;
|
|
25319
|
+
options?: WorkflowRunOptions;
|
|
23132
25320
|
}
|
|
23133
25321
|
/**
|
|
23134
25322
|
* A single changed file and its unified diff.
|
|
@@ -23677,6 +25865,10 @@ export interface SessionFactoryPauseAtCheckpointResult {
|
|
|
23677
25865
|
action: FactoryPauseCheckpointAction;
|
|
23678
25866
|
}
|
|
23679
25867
|
/** @experimental */
|
|
25868
|
+
export interface SessionWorkflowPauseAtCheckpointResult {
|
|
25869
|
+
action: WorkflowPauseCheckpointAction;
|
|
25870
|
+
}
|
|
25871
|
+
/** @experimental */
|
|
23680
25872
|
export interface SessionModelListRequest {
|
|
23681
25873
|
/**
|
|
23682
25874
|
* If true, bypasses the per-session model list cache and re-fetches from CAPI.
|
|
@@ -23705,6 +25897,13 @@ export interface SessionMcpAppsCallToolResult {
|
|
|
23705
25897
|
[k: string]: JsonValue | undefined;
|
|
23706
25898
|
}
|
|
23707
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 */
|
|
23708
25907
|
export interface SessionPluginsReloadRequest {
|
|
23709
25908
|
/**
|
|
23710
25909
|
* Reload MCP server connections after refreshing plugins. Defaults to true.
|
|
@@ -24000,6 +26199,14 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
24000
26199
|
* @returns Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success.
|
|
24001
26200
|
*/
|
|
24002
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>;
|
|
24003
26210
|
};
|
|
24004
26211
|
/** @experimental */
|
|
24005
26212
|
plugins: {
|
|
@@ -24230,7 +26437,7 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
24230
26437
|
/**
|
|
24231
26438
|
* Registers an SDK client as the session filesystem provider.
|
|
24232
26439
|
*
|
|
24233
|
-
* @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.
|
|
24234
26441
|
*
|
|
24235
26442
|
* @returns Indicates whether the calling client was registered as the session filesystem provider.
|
|
24236
26443
|
*/
|
|
@@ -24724,6 +26931,108 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
24724
26931
|
};
|
|
24725
26932
|
};
|
|
24726
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 */
|
|
24727
27036
|
model: {
|
|
24728
27037
|
/**
|
|
24729
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.
|
|
@@ -25429,13 +27738,168 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25429
27738
|
};
|
|
25430
27739
|
};
|
|
25431
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 */
|
|
25432
27821
|
plugins: {
|
|
25433
27822
|
/**
|
|
25434
|
-
* 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.
|
|
25435
27824
|
*
|
|
25436
27825
|
* @returns Plugins installed for the session, with their enabled state and version metadata.
|
|
25437
27826
|
*/
|
|
25438
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
|
+
};
|
|
25439
27903
|
/**
|
|
25440
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.
|
|
25441
27905
|
*
|
|
@@ -25461,6 +27925,14 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25461
27925
|
* @returns The selectable model entries synthesized for the models added by this call.
|
|
25462
27926
|
*/
|
|
25463
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>;
|
|
25464
27936
|
};
|
|
25465
27937
|
/** @experimental */
|
|
25466
27938
|
options: {
|
|
@@ -25786,9 +28258,9 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25786
28258
|
*/
|
|
25787
28259
|
setRequired: (params: PermissionsSetRequiredRequest) => Promise<PermissionsSetRequiredResult>;
|
|
25788
28260
|
/**
|
|
25789
|
-
* Clears session-scoped tool
|
|
28261
|
+
* Clears session-scoped tool approvals and, for full resets, exact session-approved paths.
|
|
25790
28262
|
*
|
|
25791
|
-
* @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.
|
|
25792
28264
|
*
|
|
25793
28265
|
* @returns Indicates whether the operation succeeded.
|
|
25794
28266
|
*/
|
|
@@ -25804,9 +28276,9 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25804
28276
|
/** @experimental */
|
|
25805
28277
|
paths: {
|
|
25806
28278
|
/**
|
|
25807
|
-
* Returns the session's
|
|
28279
|
+
* Returns the session's recursive directory grants, exact session-approved paths, and primary working directory.
|
|
25808
28280
|
*
|
|
25809
|
-
* @returns Snapshot of the session's
|
|
28281
|
+
* @returns Snapshot of the session's recursive directory grants, exact session-approved paths, and primary working directory.
|
|
25810
28282
|
*/
|
|
25811
28283
|
list: () => Promise<PermissionPathsList>;
|
|
25812
28284
|
/**
|
|
@@ -26144,6 +28616,22 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
26144
28616
|
* @returns Result of editing a queued message.
|
|
26145
28617
|
*/
|
|
26146
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>;
|
|
26147
28635
|
/**
|
|
26148
28636
|
* Duplicates an addressable queued item immediately after its source.
|
|
26149
28637
|
*
|
|
@@ -26320,6 +28808,26 @@ export interface FactoryHandler {
|
|
|
26320
28808
|
*/
|
|
26321
28809
|
abort(params: FactoryAbortRequest): Promise<FactoryAckResult>;
|
|
26322
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
|
+
}
|
|
26323
28831
|
/** Handler for `tasks` client session API methods. */
|
|
26324
28832
|
/** @experimental */
|
|
26325
28833
|
export interface TasksHandler {
|
|
@@ -26470,6 +28978,7 @@ export interface CanvasHandler {
|
|
|
26470
28978
|
export interface ClientSessionApiHandlers {
|
|
26471
28979
|
providerToken?: ProviderTokenHandler;
|
|
26472
28980
|
factory?: FactoryHandler;
|
|
28981
|
+
workflow?: WorkflowHandler;
|
|
26473
28982
|
tasks?: TasksHandler;
|
|
26474
28983
|
sessionFs?: SessionFsHandler;
|
|
26475
28984
|
canvas?: CanvasHandler;
|
|
@@ -26517,7 +29026,7 @@ export interface LlmInferenceHandler {
|
|
|
26517
29026
|
/** @experimental */
|
|
26518
29027
|
export interface GitHubTelemetryHandler {
|
|
26519
29028
|
/**
|
|
26520
|
-
* 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.
|
|
26521
29030
|
*
|
|
26522
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.
|
|
26523
29032
|
*/
|