@github/copilot-sdk 1.0.14 → 1.0.15-preview.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +82 -0
- package/dist/cjs/cliVersion.js +1 -1
- package/dist/cjs/client.js +15 -13
- package/dist/cjs/copilotRequestHandler.js +156 -20
- package/dist/cjs/generated/rpc.js +248 -3
- package/dist/cjs/schema.js +40 -0
- package/dist/cjs/session.js +129 -3
- package/dist/cliVersion.d.ts +1 -1
- package/dist/cliVersion.js +1 -1
- package/dist/client.d.ts +2 -0
- package/dist/client.js +13 -11
- package/dist/copilotRequestHandler.js +156 -20
- package/dist/generated/rpc.d.ts +2164 -166
- package/dist/generated/rpc.js +248 -3
- package/dist/generated/session-events.d.ts +493 -1
- package/dist/index.d.ts +1 -1
- package/dist/schema.d.ts +4 -0
- package/dist/schema.js +14 -0
- package/dist/session.d.ts +10 -3
- package/dist/session.js +129 -3
- package/dist/types.d.ts +37 -5
- package/package.json +16 -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;
|
|
@@ -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,18 @@ 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";
|
|
532
620
|
/**
|
|
533
621
|
* 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
622
|
*
|
|
@@ -549,7 +637,7 @@ export type CatalogContractViolationReason =
|
|
|
549
637
|
"both-url-and-data"
|
|
550
638
|
/** A result carried neither a URL nor embedded data, when exactly one is required. */
|
|
551
639
|
| "neither-url-nor-data"
|
|
552
|
-
/** Two results claimed the same normalised identity. */
|
|
640
|
+
/** Two results claimed the same collision key: normalised identity for existing kinds, or normalised identity and declared version for Agent Plugins. */
|
|
553
641
|
| "duplicate-identity"
|
|
554
642
|
/** A result declared no media type, or one this contract does not model. */
|
|
555
643
|
| "unknown-media-type";
|
|
@@ -564,7 +652,9 @@ export type CatalogHandleType =
|
|
|
564
652
|
/** A search candidate handle. */
|
|
565
653
|
"candidate"
|
|
566
654
|
/** An install plan handle. */
|
|
567
|
-
| "plan"
|
|
655
|
+
| "plan"
|
|
656
|
+
/** A model-safe reference to one retained search candidate. */
|
|
657
|
+
| "selection";
|
|
568
658
|
/**
|
|
569
659
|
* Why a presented handle was rejected
|
|
570
660
|
*
|
|
@@ -573,16 +663,20 @@ export type CatalogHandleType =
|
|
|
573
663
|
*/
|
|
574
664
|
/** @experimental */
|
|
575
665
|
export type CatalogHandleRejectionReason =
|
|
576
|
-
/** The handle is unparseable
|
|
666
|
+
/** The handle is unparseable or unknown. */
|
|
577
667
|
"invalid"
|
|
578
668
|
/** The handle's time to live has elapsed. */
|
|
579
669
|
| "stale"
|
|
580
670
|
/** The handle has already been used, and handles are single-use. */
|
|
581
671
|
| "replayed"
|
|
582
|
-
/** The handle was issued by a different runtime instance. */
|
|
583
|
-
| "foreign"
|
|
672
|
+
/** The handle was issued by a different runtime instance or session. */
|
|
673
|
+
| "foreign"
|
|
674
|
+
/** The handle was issued for another catalog operation. */
|
|
675
|
+
| "wrong-kind"
|
|
676
|
+
/** The supplied search identifier does not match the retained candidate. */
|
|
677
|
+
| "search-mismatch";
|
|
584
678
|
/**
|
|
585
|
-
* Which request field was rejected
|
|
679
|
+
* Which request field was rejected locally or by the catalog authority
|
|
586
680
|
*
|
|
587
681
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
588
682
|
* via the `definition` "CatalogInvalidRequestField".
|
|
@@ -602,7 +696,15 @@ export type CatalogInvalidRequestField =
|
|
|
602
696
|
/** The supplied card was missing its media type, URL, or data. */
|
|
603
697
|
| "card"
|
|
604
698
|
/** The requested configuration scope is not one this runtime writes. */
|
|
605
|
-
| "scope"
|
|
699
|
+
| "scope"
|
|
700
|
+
/** The pagination token or target was invalid, or the authority rejected the continuation. Repeat the search without page. */
|
|
701
|
+
| "page"
|
|
702
|
+
/** The locally owned session identifier was missing or malformed. */
|
|
703
|
+
| "sessionId"
|
|
704
|
+
/** The opaque selection reference was missing or malformed. */
|
|
705
|
+
| "selectionRef"
|
|
706
|
+
/** The terminal selection outcome was missing or unsupported. */
|
|
707
|
+
| "outcome";
|
|
606
708
|
/**
|
|
607
709
|
* How a card failed validation
|
|
608
710
|
*
|
|
@@ -634,7 +736,9 @@ export type CatalogMediaType =
|
|
|
634
736
|
/** The legacy MCP server card media type, accepted for compatibility. */
|
|
635
737
|
| "application/mcp-server+json"
|
|
636
738
|
/** An AI skill card. Representable and searchable, but typed non-installable. */
|
|
637
|
-
| "application/ai-skill"
|
|
739
|
+
| "application/ai-skill"
|
|
740
|
+
/** An inert Agent Plugin descriptor. */
|
|
741
|
+
| "application/vnd.github.copilot-plugin";
|
|
638
742
|
/**
|
|
639
743
|
* Why capability and protocol-version negotiation refused a caller
|
|
640
744
|
*
|
|
@@ -707,6 +811,16 @@ export type McpPlanPolicySource =
|
|
|
707
811
|
| "registry-policy"
|
|
708
812
|
/** Local trust settings evaluated the server. */
|
|
709
813
|
| "local-trust";
|
|
814
|
+
/**
|
|
815
|
+
* Relationship of the backend-reported count to the complete query result set.
|
|
816
|
+
*
|
|
817
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
818
|
+
* via the `definition` "CatalogSearchTotalCountRelation".
|
|
819
|
+
*/
|
|
820
|
+
/** @experimental */
|
|
821
|
+
export type CatalogSearchTotalCountRelation =
|
|
822
|
+
/** No exact/full-query or lower-bound guarantee is available. */
|
|
823
|
+
"unknown";
|
|
710
824
|
/**
|
|
711
825
|
* Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success.
|
|
712
826
|
*
|
|
@@ -747,10 +861,36 @@ export type CatalogUnavailableReason =
|
|
|
747
861
|
"search-unavailable"
|
|
748
862
|
/** Install planning is not wired up on this runtime build. */
|
|
749
863
|
| "planning-unavailable"
|
|
864
|
+
/** Exact candidate selection is not available in this session or runtime. */
|
|
865
|
+
| "selection-unavailable"
|
|
750
866
|
/** No catalog authority is configured for this runtime. */
|
|
751
867
|
| "authority-not-configured"
|
|
752
868
|
/** The surface is disabled by policy on this runtime. */
|
|
753
869
|
| "disabled-by-policy";
|
|
870
|
+
/**
|
|
871
|
+
* Terminal outcome declared for a retained catalog selection group
|
|
872
|
+
*
|
|
873
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
874
|
+
* via the `definition` "CatalogSelectionDecision".
|
|
875
|
+
*/
|
|
876
|
+
/** @experimental */
|
|
877
|
+
export type CatalogSelectionDecision =
|
|
878
|
+
/** Choose the candidate named by selectionRef. */
|
|
879
|
+
"selected"
|
|
880
|
+
/** Explicitly decline every candidate in the search. */
|
|
881
|
+
| "declined"
|
|
882
|
+
/** Cancel the selection interaction without choosing a candidate. */
|
|
883
|
+
| "cancelled"
|
|
884
|
+
/** Declare that the host's live interaction deadline elapsed while the reference remained valid. */
|
|
885
|
+
| "timed-out";
|
|
886
|
+
/**
|
|
887
|
+
* 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.
|
|
888
|
+
*
|
|
889
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
890
|
+
* via the `definition` "CatalogSelectionResult".
|
|
891
|
+
*/
|
|
892
|
+
/** @experimental */
|
|
893
|
+
export type CatalogSelectionResult = CatalogSelectionSelected | CatalogSelectionDeclined | CatalogSelectionCancelled | CatalogSelectionTimedOut | CatalogSelectionInvalid | CatalogSelectionStale | CatalogSelectionReplayed | CatalogSelectionForeign | CatalogSelectionWrongKind | CatalogNegotiationRefusedError | CatalogInvalidRequestError | CatalogUnavailableError;
|
|
754
894
|
/**
|
|
755
895
|
* Why no usable transport could be offered
|
|
756
896
|
*
|
|
@@ -3993,6 +4133,209 @@ export type UISessionLimitsExhaustedResponseAction =
|
|
|
3993
4133
|
| "unset"
|
|
3994
4134
|
/** Leave the limit unchanged and cancel the blocked model request. */
|
|
3995
4135
|
| "cancel";
|
|
4136
|
+
/**
|
|
4137
|
+
* Execution-critical workflow storage operation.
|
|
4138
|
+
*
|
|
4139
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4140
|
+
* via the `definition` "WorkflowDurableOperation".
|
|
4141
|
+
*/
|
|
4142
|
+
/** @experimental */
|
|
4143
|
+
export type WorkflowDurableOperation =
|
|
4144
|
+
/** Creating the durable run and declared phases. */
|
|
4145
|
+
"createRun"
|
|
4146
|
+
/** Persisting the transition to running. */
|
|
4147
|
+
| "markRunStarted"
|
|
4148
|
+
/** Persisting the terminal run envelope. */
|
|
4149
|
+
| "finishRun"
|
|
4150
|
+
/** Persisting subagent admission accounting. */
|
|
4151
|
+
| "reserveAgent"
|
|
4152
|
+
/** Rolling back an uncommitted subagent admission. */
|
|
4153
|
+
| "releaseAgent"
|
|
4154
|
+
/** Persisting an idempotent model-usage charge. */
|
|
4155
|
+
| "chargeCredit"
|
|
4156
|
+
/** Persisting active execution time. */
|
|
4157
|
+
| "addElapsed"
|
|
4158
|
+
/** Reading the authoritative AI-credit total. */
|
|
4159
|
+
| "reconcileCreditTotal"
|
|
4160
|
+
/** Reading a journal entry without treating storage failure as a cache miss. */
|
|
4161
|
+
| "journalGet"
|
|
4162
|
+
/** Persisting a journal entry before reporting success. */
|
|
4163
|
+
| "journalPut"
|
|
4164
|
+
/** Renewing the durable owner lease that proves this process still owns the run. */
|
|
4165
|
+
| "refreshLease";
|
|
4166
|
+
/**
|
|
4167
|
+
* Current or terminal state of a workflow run.
|
|
4168
|
+
*
|
|
4169
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4170
|
+
* via the `definition` "WorkflowRunStatus".
|
|
4171
|
+
*/
|
|
4172
|
+
/** @experimental */
|
|
4173
|
+
export type WorkflowRunStatus =
|
|
4174
|
+
/** The run was minted and is awaiting approval. */
|
|
4175
|
+
"pending"
|
|
4176
|
+
/** The run is executing. */
|
|
4177
|
+
| "running"
|
|
4178
|
+
/** The run completed successfully. */
|
|
4179
|
+
| "completed"
|
|
4180
|
+
/** The run was interrupted while resource budget remained. */
|
|
4181
|
+
| "halted"
|
|
4182
|
+
/** The current attempt stopped intentionally and the run may be resumed. */
|
|
4183
|
+
| "paused"
|
|
4184
|
+
/** The run was cancelled before completion. */
|
|
4185
|
+
| "cancelled"
|
|
4186
|
+
/** The workflow body failed or reached a cumulative resource ceiling. */
|
|
4187
|
+
| "error";
|
|
4188
|
+
/**
|
|
4189
|
+
* Machine-readable workflow run failure.
|
|
4190
|
+
*
|
|
4191
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4192
|
+
* via the `definition` "WorkflowRunFailure".
|
|
4193
|
+
*/
|
|
4194
|
+
/** @experimental */
|
|
4195
|
+
export type WorkflowRunFailure = {
|
|
4196
|
+
kind: WorkflowRunFailureKind;
|
|
4197
|
+
/**
|
|
4198
|
+
* Approved effective ceiling that was reached.
|
|
4199
|
+
*/
|
|
4200
|
+
value: number;
|
|
4201
|
+
/**
|
|
4202
|
+
* Suggested larger ceiling when the runtime can derive one safely.
|
|
4203
|
+
*/
|
|
4204
|
+
suggestedValue?: number;
|
|
4205
|
+
/**
|
|
4206
|
+
* Workflow run identifier.
|
|
4207
|
+
*/
|
|
4208
|
+
runId: string;
|
|
4209
|
+
/**
|
|
4210
|
+
* Workflow failure variant discriminator.
|
|
4211
|
+
*/
|
|
4212
|
+
type: "workflow_limit_reached";
|
|
4213
|
+
} | {
|
|
4214
|
+
/**
|
|
4215
|
+
* Workflow run identifier whose changed limits were declined.
|
|
4216
|
+
*/
|
|
4217
|
+
runId: string;
|
|
4218
|
+
/**
|
|
4219
|
+
* Human-readable reason the resume did not proceed.
|
|
4220
|
+
*/
|
|
4221
|
+
reason: string;
|
|
4222
|
+
/**
|
|
4223
|
+
* Workflow failure variant discriminator.
|
|
4224
|
+
*/
|
|
4225
|
+
type: "workflow_resume_declined";
|
|
4226
|
+
} | {
|
|
4227
|
+
/**
|
|
4228
|
+
* Stable failure code.
|
|
4229
|
+
*/
|
|
4230
|
+
code: string;
|
|
4231
|
+
operation: WorkflowDurableOperation;
|
|
4232
|
+
/**
|
|
4233
|
+
* Workflow run identifier.
|
|
4234
|
+
*/
|
|
4235
|
+
runId: string;
|
|
4236
|
+
/**
|
|
4237
|
+
* Workflow failure variant discriminator.
|
|
4238
|
+
*/
|
|
4239
|
+
type: "workflow_durable_failure";
|
|
4240
|
+
} | {
|
|
4241
|
+
/**
|
|
4242
|
+
* Workflow run identifier.
|
|
4243
|
+
*/
|
|
4244
|
+
runId: string;
|
|
4245
|
+
/**
|
|
4246
|
+
* Confirmed usage in nano-AIU, representing the floor of what the run spent.
|
|
4247
|
+
*/
|
|
4248
|
+
drainedNanoAiu: number;
|
|
4249
|
+
/**
|
|
4250
|
+
* Workflow failure variant discriminator.
|
|
4251
|
+
*/
|
|
4252
|
+
type: "workflow_accounting_incomplete";
|
|
4253
|
+
} | {
|
|
4254
|
+
/**
|
|
4255
|
+
* Workflow run identifier.
|
|
4256
|
+
*/
|
|
4257
|
+
runId: string;
|
|
4258
|
+
/**
|
|
4259
|
+
* Workflow failure variant discriminator.
|
|
4260
|
+
*/
|
|
4261
|
+
type: "workflow_provider_disconnected";
|
|
4262
|
+
};
|
|
4263
|
+
/**
|
|
4264
|
+
* Cumulative resource ceiling that stopped a workflow run.
|
|
4265
|
+
*
|
|
4266
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4267
|
+
* via the `definition` "WorkflowRunFailureKind".
|
|
4268
|
+
*/
|
|
4269
|
+
/** @experimental */
|
|
4270
|
+
export type WorkflowRunFailureKind =
|
|
4271
|
+
/** The run admitted the approved maximum total number of subagents. */
|
|
4272
|
+
"maxTotalSubagents"
|
|
4273
|
+
/** The run reached the approved accumulated active-execution time in seconds. */
|
|
4274
|
+
| "timeoutSeconds"
|
|
4275
|
+
/** The run's settled subagent model usage exceeded the approved AI-credit ceiling, or no headroom remained for another subagent. */
|
|
4276
|
+
| "maxAiCredits";
|
|
4277
|
+
/**
|
|
4278
|
+
* Durable metadata describing who initiated a workflow pause.
|
|
4279
|
+
*
|
|
4280
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4281
|
+
* via the `definition` "WorkflowPauseInfo".
|
|
4282
|
+
*/
|
|
4283
|
+
/** @experimental */
|
|
4284
|
+
export type WorkflowPauseInfo = {
|
|
4285
|
+
/**
|
|
4286
|
+
* Workflow pause initiator discriminator.
|
|
4287
|
+
*/
|
|
4288
|
+
type: "user";
|
|
4289
|
+
} | {
|
|
4290
|
+
/**
|
|
4291
|
+
* Stable author-defined checkpoint key that initiated the pause.
|
|
4292
|
+
*/
|
|
4293
|
+
key: string;
|
|
4294
|
+
/**
|
|
4295
|
+
* Workflow pause initiator discriminator.
|
|
4296
|
+
*/
|
|
4297
|
+
type: "checkpoint";
|
|
4298
|
+
};
|
|
4299
|
+
/**
|
|
4300
|
+
* Kind of workflow progress line.
|
|
4301
|
+
*
|
|
4302
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4303
|
+
* via the `definition` "WorkflowLogLineKind".
|
|
4304
|
+
*/
|
|
4305
|
+
/** @experimental */
|
|
4306
|
+
export type WorkflowLogLineKind =
|
|
4307
|
+
/** A narrator log line. */
|
|
4308
|
+
"log"
|
|
4309
|
+
/** A named workflow phase marker. */
|
|
4310
|
+
| "phase";
|
|
4311
|
+
/**
|
|
4312
|
+
* Action the runtime selected for a durable workflow pause checkpoint.
|
|
4313
|
+
*
|
|
4314
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4315
|
+
* via the `definition` "WorkflowPauseCheckpointAction".
|
|
4316
|
+
*/
|
|
4317
|
+
/** @experimental */
|
|
4318
|
+
export type WorkflowPauseCheckpointAction =
|
|
4319
|
+
/** The checkpoint was committed by a prior paused attempt, so execution may continue. */
|
|
4320
|
+
"continue"
|
|
4321
|
+
/** This attempt claimed the checkpoint and must cooperatively stop. */
|
|
4322
|
+
| "pause";
|
|
4323
|
+
/**
|
|
4324
|
+
* Derived lifecycle state of a workflow phase.
|
|
4325
|
+
*
|
|
4326
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
4327
|
+
* via the `definition` "WorkflowPhaseStatus".
|
|
4328
|
+
*/
|
|
4329
|
+
/** @experimental */
|
|
4330
|
+
export type WorkflowPhaseStatus =
|
|
4331
|
+
/** The phase has not been entered yet. */
|
|
4332
|
+
"pending"
|
|
4333
|
+
/** The phase is currently entered and accumulating active time. */
|
|
4334
|
+
| "active"
|
|
4335
|
+
/** The phase was entered and has since been closed. */
|
|
4336
|
+
| "completed"
|
|
4337
|
+
/** The phase was never entered because a later phase was entered or the run reached a terminal state. */
|
|
4338
|
+
| "skipped";
|
|
3996
4339
|
/**
|
|
3997
4340
|
* Type of change represented by this file diff.
|
|
3998
4341
|
*
|
|
@@ -4275,6 +4618,15 @@ export interface CopilotUserResponse {
|
|
|
4275
4618
|
* Whether CLI remote control is enabled for the user.
|
|
4276
4619
|
*/
|
|
4277
4620
|
cli_remote_control_enabled?: boolean;
|
|
4621
|
+
/**
|
|
4622
|
+
* Enterprises that provide the user's Copilot license, each with a stable numeric ID.
|
|
4623
|
+
*/
|
|
4624
|
+
enterprise_list?: {
|
|
4625
|
+
/**
|
|
4626
|
+
* Numeric database ID of the enterprise.
|
|
4627
|
+
*/
|
|
4628
|
+
id: number;
|
|
4629
|
+
}[];
|
|
4278
4630
|
}
|
|
4279
4631
|
/**
|
|
4280
4632
|
* Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough.
|
|
@@ -5849,33 +6201,17 @@ export interface CardDigest {
|
|
|
5849
6201
|
value: CardDigestValue;
|
|
5850
6202
|
}
|
|
5851
6203
|
/**
|
|
5852
|
-
* An inert
|
|
6204
|
+
* 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
6205
|
*
|
|
5854
6206
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5855
|
-
* via the `definition` "
|
|
6207
|
+
* via the `definition` "CatalogAgentPluginCandidate".
|
|
5856
6208
|
*/
|
|
5857
6209
|
/** @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";
|
|
6210
|
+
export interface CatalogAgentPluginCandidate {
|
|
6211
|
+
kind: CatalogAgentPluginCandidateKind;
|
|
6212
|
+
mediaType: CatalogAgentPluginMediaType;
|
|
6213
|
+
identity: CatalogResourceIdentity;
|
|
6214
|
+
version?: CatalogResourceVersion;
|
|
5879
6215
|
/**
|
|
5880
6216
|
* Display name taken verbatim from the card. Inert untrusted text.
|
|
5881
6217
|
*/
|
|
@@ -5888,48 +6224,43 @@ export interface CatalogAiSkillCandidate {
|
|
|
5888
6224
|
* Publisher taken verbatim from the card. Inert untrusted text.
|
|
5889
6225
|
*/
|
|
5890
6226
|
publisher?: string;
|
|
5891
|
-
source:
|
|
5892
|
-
|
|
6227
|
+
source: CatalogPluginRepositorySource;
|
|
6228
|
+
/**
|
|
6229
|
+
* 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`.
|
|
6230
|
+
*
|
|
6231
|
+
* @maxItems 3
|
|
6232
|
+
*/
|
|
6233
|
+
compatibilityTags: ({
|
|
6234
|
+
[k: string]: unknown | undefined;
|
|
6235
|
+
} & []) | [CatalogAgentPluginCompatibilityTag] | [CatalogAgentPluginCompatibilityTag, CatalogAgentPluginCompatibilityTag] | [CatalogAgentPluginCompatibilityTag, CatalogAgentPluginCompatibilityTag, CatalogAgentPluginCompatibilityTag];
|
|
6236
|
+
provenance: CatalogAgentPluginCandidateProvenance;
|
|
5893
6237
|
trust?: CatalogTrustSnapshot;
|
|
5894
6238
|
}
|
|
5895
6239
|
/**
|
|
5896
|
-
*
|
|
6240
|
+
* 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
6241
|
*
|
|
5898
6242
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5899
|
-
* via the `definition` "
|
|
6243
|
+
* via the `definition` "CatalogPluginRepositorySource".
|
|
5900
6244
|
*/
|
|
5901
6245
|
/** @experimental */
|
|
5902
|
-
export interface
|
|
5903
|
-
/**
|
|
5904
|
-
* Discriminator: the card is URL-backed, and carries no embedded data
|
|
5905
|
-
*/
|
|
5906
|
-
kind: "url";
|
|
6246
|
+
export interface CatalogPluginRepositorySource {
|
|
5907
6247
|
/**
|
|
5908
|
-
*
|
|
6248
|
+
* Canonical lowercase owner/repository name derived from metadata.sourceSet.
|
|
5909
6249
|
*/
|
|
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 {
|
|
6250
|
+
repository: string;
|
|
5920
6251
|
/**
|
|
5921
|
-
*
|
|
6252
|
+
* Case-preserving safe relative POSIX path derived from metadata.repoPath.
|
|
5922
6253
|
*/
|
|
5923
|
-
|
|
6254
|
+
path: string;
|
|
5924
6255
|
}
|
|
5925
6256
|
/**
|
|
5926
|
-
* Where and when an
|
|
6257
|
+
* 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
6258
|
*
|
|
5928
6259
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
5929
|
-
* via the `definition` "
|
|
6260
|
+
* via the `definition` "CatalogAgentPluginCandidateProvenance".
|
|
5930
6261
|
*/
|
|
5931
6262
|
/** @experimental */
|
|
5932
|
-
export interface
|
|
6263
|
+
export interface CatalogAgentPluginCandidateProvenance {
|
|
5933
6264
|
/**
|
|
5934
6265
|
* Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data.
|
|
5935
6266
|
*/
|
|
@@ -5938,10 +6269,7 @@ export interface CatalogAiSkillCandidateProvenance {
|
|
|
5938
6269
|
* ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp.
|
|
5939
6270
|
*/
|
|
5940
6271
|
observedAt: string;
|
|
5941
|
-
|
|
5942
|
-
* Media type advertised for the referenced AI skill card
|
|
5943
|
-
*/
|
|
5944
|
-
mediaType: "application/ai-skill";
|
|
6272
|
+
mediaType: CatalogAgentPluginMediaType;
|
|
5945
6273
|
}
|
|
5946
6274
|
/**
|
|
5947
6275
|
* A recognised current Agent Finder T1 or T2 trust tier.
|
|
@@ -6049,6 +6377,89 @@ export interface CatalogTrustSnapshotMalformed {
|
|
|
6049
6377
|
eligibility: CatalogTrustEligibility;
|
|
6050
6378
|
provenance: CatalogTrustProvenance;
|
|
6051
6379
|
}
|
|
6380
|
+
/**
|
|
6381
|
+
* An inert AI skill catalog result. AI skills are discovery-only and cannot be represented as installable through this surface.
|
|
6382
|
+
*
|
|
6383
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6384
|
+
* via the `definition` "CatalogAiSkillCandidate".
|
|
6385
|
+
*/
|
|
6386
|
+
/** @experimental */
|
|
6387
|
+
export interface CatalogAiSkillCandidate {
|
|
6388
|
+
/**
|
|
6389
|
+
* 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.
|
|
6390
|
+
*/
|
|
6391
|
+
handle: string;
|
|
6392
|
+
/**
|
|
6393
|
+
* ISO 8601 timestamp after which the handle is stale and will be rejected.
|
|
6394
|
+
*/
|
|
6395
|
+
handleExpiresAt: string;
|
|
6396
|
+
kind: CatalogAiSkillCandidateKind;
|
|
6397
|
+
mediaType: CatalogAiSkillMediaType;
|
|
6398
|
+
installability: CatalogAiSkillInstallability;
|
|
6399
|
+
/**
|
|
6400
|
+
* Display name taken verbatim from the card. Inert untrusted text.
|
|
6401
|
+
*/
|
|
6402
|
+
displayName: string;
|
|
6403
|
+
/**
|
|
6404
|
+
* Description taken verbatim from the card. Inert untrusted text.
|
|
6405
|
+
*/
|
|
6406
|
+
description?: string;
|
|
6407
|
+
/**
|
|
6408
|
+
* Publisher taken verbatim from the card. Inert untrusted text.
|
|
6409
|
+
*/
|
|
6410
|
+
publisher?: string;
|
|
6411
|
+
source: CatalogCandidateSource;
|
|
6412
|
+
provenance: CatalogAiSkillCandidateProvenance;
|
|
6413
|
+
trust?: CatalogTrustSnapshot;
|
|
6414
|
+
}
|
|
6415
|
+
/**
|
|
6416
|
+
* Candidate whose card is retrieved from a URL through the runtime's hardened fetch boundary.
|
|
6417
|
+
*
|
|
6418
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6419
|
+
* via the `definition` "CatalogCandidateSourceUrl".
|
|
6420
|
+
*/
|
|
6421
|
+
/** @experimental */
|
|
6422
|
+
export interface CatalogCandidateSourceUrl {
|
|
6423
|
+
/**
|
|
6424
|
+
* Discriminator: the card is URL-backed, and carries no embedded data
|
|
6425
|
+
*/
|
|
6426
|
+
kind: "url";
|
|
6427
|
+
/**
|
|
6428
|
+
* Card URL as advertised. Inert untrusted data: the runtime retrieves it only through its own hardened boundary, and it is never logged.
|
|
6429
|
+
*/
|
|
6430
|
+
url: string;
|
|
6431
|
+
}
|
|
6432
|
+
/**
|
|
6433
|
+
* Candidate whose card reference arrived inline. The document and its content-derived properties stay behind the runtime boundary.
|
|
6434
|
+
*
|
|
6435
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6436
|
+
* via the `definition` "CatalogCandidateSourceEmbedded".
|
|
6437
|
+
*/
|
|
6438
|
+
/** @experimental */
|
|
6439
|
+
export interface CatalogCandidateSourceEmbedded {
|
|
6440
|
+
/**
|
|
6441
|
+
* Discriminator: the card is embedded, and carries no URL
|
|
6442
|
+
*/
|
|
6443
|
+
kind: "embedded";
|
|
6444
|
+
}
|
|
6445
|
+
/**
|
|
6446
|
+
* 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.
|
|
6447
|
+
*
|
|
6448
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6449
|
+
* via the `definition` "CatalogAiSkillCandidateProvenance".
|
|
6450
|
+
*/
|
|
6451
|
+
/** @experimental */
|
|
6452
|
+
export interface CatalogAiSkillCandidateProvenance {
|
|
6453
|
+
/**
|
|
6454
|
+
* Host of the catalog authority that advertised the reference, without path, query, or credentials. Inert untrusted data.
|
|
6455
|
+
*/
|
|
6456
|
+
authority: string;
|
|
6457
|
+
/**
|
|
6458
|
+
* ISO 8601 timestamp at which the runtime observed the catalog reference. This is not a retrieval or validation timestamp.
|
|
6459
|
+
*/
|
|
6460
|
+
observedAt: string;
|
|
6461
|
+
mediaType: CatalogAiSkillMediaType;
|
|
6462
|
+
}
|
|
6052
6463
|
/**
|
|
6053
6464
|
* 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
6465
|
*
|
|
@@ -6083,10 +6494,7 @@ export interface CatalogMcpServerCandidate {
|
|
|
6083
6494
|
* ISO 8601 timestamp after which the handle is stale and will be rejected.
|
|
6084
6495
|
*/
|
|
6085
6496
|
handleExpiresAt: string;
|
|
6086
|
-
|
|
6087
|
-
* Discriminator: this candidate describes an MCP server
|
|
6088
|
-
*/
|
|
6089
|
-
kind: "mcp-server";
|
|
6497
|
+
kind: CatalogMcpServerCandidateKind;
|
|
6090
6498
|
mediaType: McpServerCardMediaType;
|
|
6091
6499
|
installability: CatalogMcpServerInstallability;
|
|
6092
6500
|
/**
|
|
@@ -6180,7 +6588,7 @@ export interface CatalogHandleRejectedError {
|
|
|
6180
6588
|
message: string;
|
|
6181
6589
|
}
|
|
6182
6590
|
/**
|
|
6183
|
-
* The request was rejected
|
|
6591
|
+
* 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
6592
|
*
|
|
6185
6593
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6186
6594
|
* via the `definition` "CatalogInvalidRequestError".
|
|
@@ -6229,7 +6637,7 @@ export interface CatalogNegotiatedContract {
|
|
|
6229
6637
|
*/
|
|
6230
6638
|
runtimeProtocolVersion: number;
|
|
6231
6639
|
/**
|
|
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.
|
|
6640
|
+
* 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
6641
|
*/
|
|
6234
6642
|
grantedCapabilities: CatalogCapability[];
|
|
6235
6643
|
}
|
|
@@ -6333,6 +6741,61 @@ export interface CatalogPolicyRejectedError {
|
|
|
6333
6741
|
*/
|
|
6334
6742
|
message: string;
|
|
6335
6743
|
}
|
|
6744
|
+
/**
|
|
6745
|
+
* 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.
|
|
6746
|
+
*
|
|
6747
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6748
|
+
* via the `definition` "CatalogSearchPage".
|
|
6749
|
+
*/
|
|
6750
|
+
/** @experimental */
|
|
6751
|
+
export interface CatalogSearchPage {
|
|
6752
|
+
/**
|
|
6753
|
+
* Opaque authority-issued pagination token from an earlier response. Never decode, modify or log it in an SDK consumer.
|
|
6754
|
+
*/
|
|
6755
|
+
token: string;
|
|
6756
|
+
/**
|
|
6757
|
+
* 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.
|
|
6758
|
+
*/
|
|
6759
|
+
number: number;
|
|
6760
|
+
}
|
|
6761
|
+
/**
|
|
6762
|
+
* 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.
|
|
6763
|
+
*
|
|
6764
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6765
|
+
* via the `definition` "CatalogSearchPagination".
|
|
6766
|
+
*/
|
|
6767
|
+
/** @experimental */
|
|
6768
|
+
export interface CatalogSearchPagination {
|
|
6769
|
+
/**
|
|
6770
|
+
* 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.
|
|
6771
|
+
*/
|
|
6772
|
+
token: string;
|
|
6773
|
+
/**
|
|
6774
|
+
* One-based page returned by the authority.
|
|
6775
|
+
*/
|
|
6776
|
+
currentPage: number;
|
|
6777
|
+
/**
|
|
6778
|
+
* Page size bound to the search, equal to the effective request limit.
|
|
6779
|
+
*/
|
|
6780
|
+
pageSize: number;
|
|
6781
|
+
/**
|
|
6782
|
+
* Backend-reported count for this response, not the number of returned candidates. Its relationship to the full query result set is unknown.
|
|
6783
|
+
*/
|
|
6784
|
+
totalCount: number;
|
|
6785
|
+
totalCountRelation: CatalogSearchTotalCountRelation;
|
|
6786
|
+
/**
|
|
6787
|
+
* 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.
|
|
6788
|
+
*/
|
|
6789
|
+
pageCount: number;
|
|
6790
|
+
/**
|
|
6791
|
+
* 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.
|
|
6792
|
+
*/
|
|
6793
|
+
maxPage: number;
|
|
6794
|
+
/**
|
|
6795
|
+
* 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.
|
|
6796
|
+
*/
|
|
6797
|
+
hasNextPage: boolean;
|
|
6798
|
+
}
|
|
6336
6799
|
/**
|
|
6337
6800
|
* 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.
|
|
6338
6801
|
*
|
|
@@ -6351,15 +6814,16 @@ export interface CatalogSearchRequest {
|
|
|
6351
6814
|
*/
|
|
6352
6815
|
limit?: number;
|
|
6353
6816
|
/**
|
|
6354
|
-
* Restrict results to these candidate kinds.
|
|
6817
|
+
* 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
6818
|
*
|
|
6356
6819
|
* @minItems 1
|
|
6357
|
-
* @maxItems
|
|
6820
|
+
* @maxItems 3
|
|
6358
6821
|
*/
|
|
6359
|
-
kinds?: [CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind];
|
|
6822
|
+
kinds?: [CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind] | [CatalogCandidateKind, CatalogCandidateKind, CatalogCandidateKind];
|
|
6823
|
+
page?: CatalogSearchPage;
|
|
6360
6824
|
}
|
|
6361
6825
|
/**
|
|
6362
|
-
* A completed catalog search
|
|
6826
|
+
* 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
6827
|
*
|
|
6364
6828
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6365
6829
|
* via the `definition` "CatalogSearchSucceeded".
|
|
@@ -6381,10 +6845,11 @@ export interface CatalogSearchSucceeded {
|
|
|
6381
6845
|
*/
|
|
6382
6846
|
candidates: CatalogCandidate[];
|
|
6383
6847
|
/**
|
|
6384
|
-
*
|
|
6848
|
+
* 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
6849
|
*/
|
|
6386
6850
|
truncated: boolean;
|
|
6387
6851
|
negotiated: CatalogNegotiatedContract;
|
|
6852
|
+
pagination?: CatalogSearchPagination;
|
|
6388
6853
|
}
|
|
6389
6854
|
/**
|
|
6390
6855
|
* The request asked for a candidate kind this runtime does not serve.
|
|
@@ -6447,6 +6912,182 @@ export interface CatalogUnavailableError {
|
|
|
6447
6912
|
*/
|
|
6448
6913
|
message: string;
|
|
6449
6914
|
}
|
|
6915
|
+
/**
|
|
6916
|
+
* The caller cancelled the selection interaction and the retained search state was released.
|
|
6917
|
+
*
|
|
6918
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6919
|
+
* via the `definition` "CatalogSelectionCancelled".
|
|
6920
|
+
*/
|
|
6921
|
+
/** @experimental */
|
|
6922
|
+
export interface CatalogSelectionCancelled {
|
|
6923
|
+
/**
|
|
6924
|
+
* Discriminator: selection was cancelled
|
|
6925
|
+
*/
|
|
6926
|
+
kind: "cancelled";
|
|
6927
|
+
/**
|
|
6928
|
+
* The search identifier privately bound to the released selection group.
|
|
6929
|
+
*/
|
|
6930
|
+
searchId: string;
|
|
6931
|
+
}
|
|
6932
|
+
/**
|
|
6933
|
+
* The caller explicitly declined every candidate and the retained search state was released.
|
|
6934
|
+
*
|
|
6935
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6936
|
+
* via the `definition` "CatalogSelectionDeclined".
|
|
6937
|
+
*/
|
|
6938
|
+
/** @experimental */
|
|
6939
|
+
export interface CatalogSelectionDeclined {
|
|
6940
|
+
/**
|
|
6941
|
+
* Discriminator: the candidates were declined
|
|
6942
|
+
*/
|
|
6943
|
+
kind: "declined";
|
|
6944
|
+
/**
|
|
6945
|
+
* The search identifier privately bound to the released selection group.
|
|
6946
|
+
*/
|
|
6947
|
+
searchId: string;
|
|
6948
|
+
}
|
|
6949
|
+
/**
|
|
6950
|
+
* The selection reference belongs to another runtime instance or session.
|
|
6951
|
+
*
|
|
6952
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6953
|
+
* via the `definition` "CatalogSelectionForeign".
|
|
6954
|
+
*/
|
|
6955
|
+
/** @experimental */
|
|
6956
|
+
export interface CatalogSelectionForeign {
|
|
6957
|
+
/**
|
|
6958
|
+
* Discriminator for this typed selection rejection
|
|
6959
|
+
*/
|
|
6960
|
+
kind: "foreign";
|
|
6961
|
+
/**
|
|
6962
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
6963
|
+
*/
|
|
6964
|
+
message: string;
|
|
6965
|
+
}
|
|
6966
|
+
/**
|
|
6967
|
+
* The selection reference was malformed or unknown.
|
|
6968
|
+
*
|
|
6969
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6970
|
+
* via the `definition` "CatalogSelectionInvalid".
|
|
6971
|
+
*/
|
|
6972
|
+
/** @experimental */
|
|
6973
|
+
export interface CatalogSelectionInvalid {
|
|
6974
|
+
/**
|
|
6975
|
+
* Discriminator for this typed selection rejection
|
|
6976
|
+
*/
|
|
6977
|
+
kind: "invalid";
|
|
6978
|
+
/**
|
|
6979
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
6980
|
+
*/
|
|
6981
|
+
message: string;
|
|
6982
|
+
}
|
|
6983
|
+
/**
|
|
6984
|
+
* The selection group was already terminated or its pending host hand-off was already claimed.
|
|
6985
|
+
*
|
|
6986
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
6987
|
+
* via the `definition` "CatalogSelectionReplayed".
|
|
6988
|
+
*/
|
|
6989
|
+
/** @experimental */
|
|
6990
|
+
export interface CatalogSelectionReplayed {
|
|
6991
|
+
/**
|
|
6992
|
+
* Discriminator for this typed selection rejection
|
|
6993
|
+
*/
|
|
6994
|
+
kind: "replayed";
|
|
6995
|
+
/**
|
|
6996
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
6997
|
+
*/
|
|
6998
|
+
message: string;
|
|
6999
|
+
}
|
|
7000
|
+
/**
|
|
7001
|
+
* Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.
|
|
7002
|
+
*
|
|
7003
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7004
|
+
* via the `definition` "CatalogSelectionRequest".
|
|
7005
|
+
*/
|
|
7006
|
+
/** @experimental */
|
|
7007
|
+
export interface CatalogSelectionRequest {
|
|
7008
|
+
contract: CatalogClientContract;
|
|
7009
|
+
/**
|
|
7010
|
+
* Locally owned root session whose retained search state is being resolved.
|
|
7011
|
+
*/
|
|
7012
|
+
sessionId: string;
|
|
7013
|
+
/**
|
|
7014
|
+
* 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.
|
|
7015
|
+
*/
|
|
7016
|
+
selectionRef: string;
|
|
7017
|
+
outcome: CatalogSelectionDecision;
|
|
7018
|
+
}
|
|
7019
|
+
/**
|
|
7020
|
+
* The chosen candidate was transferred into a fresh bounded single-use handle for a later explicit planning request.
|
|
7021
|
+
*
|
|
7022
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7023
|
+
* via the `definition` "CatalogSelectionSelected".
|
|
7024
|
+
*/
|
|
7025
|
+
/** @experimental */
|
|
7026
|
+
export interface CatalogSelectionSelected {
|
|
7027
|
+
/**
|
|
7028
|
+
* Discriminator: one candidate was selected
|
|
7029
|
+
*/
|
|
7030
|
+
kind: "selected";
|
|
7031
|
+
/**
|
|
7032
|
+
* Fresh single-use candidate handle accepted by mcp.planInstall. Returned only to the native host and never included in model-tool output.
|
|
7033
|
+
*/
|
|
7034
|
+
candidateHandle: string;
|
|
7035
|
+
/**
|
|
7036
|
+
* The exact search identifier privately bound to the selected candidate.
|
|
7037
|
+
*/
|
|
7038
|
+
searchId: string;
|
|
7039
|
+
}
|
|
7040
|
+
/**
|
|
7041
|
+
* The host declared that its live selection interaction timed out, and the retained search state was released.
|
|
7042
|
+
*
|
|
7043
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7044
|
+
* via the `definition` "CatalogSelectionTimedOut".
|
|
7045
|
+
*/
|
|
7046
|
+
/** @experimental */
|
|
7047
|
+
export interface CatalogSelectionTimedOut {
|
|
7048
|
+
/**
|
|
7049
|
+
* Discriminator: the host's live interaction timed out
|
|
7050
|
+
*/
|
|
7051
|
+
kind: "timed-out";
|
|
7052
|
+
/**
|
|
7053
|
+
* The search identifier privately bound to the released selection group.
|
|
7054
|
+
*/
|
|
7055
|
+
searchId: string;
|
|
7056
|
+
}
|
|
7057
|
+
/**
|
|
7058
|
+
* The runtime-enforced selection reference lifetime elapsed before the request arrived.
|
|
7059
|
+
*
|
|
7060
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7061
|
+
* via the `definition` "CatalogSelectionStale".
|
|
7062
|
+
*/
|
|
7063
|
+
/** @experimental */
|
|
7064
|
+
export interface CatalogSelectionStale {
|
|
7065
|
+
/**
|
|
7066
|
+
* Discriminator for this typed selection rejection
|
|
7067
|
+
*/
|
|
7068
|
+
kind: "stale";
|
|
7069
|
+
/**
|
|
7070
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
7071
|
+
*/
|
|
7072
|
+
message: string;
|
|
7073
|
+
}
|
|
7074
|
+
/**
|
|
7075
|
+
* The presented opaque handle was issued for another catalog operation.
|
|
7076
|
+
*
|
|
7077
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
7078
|
+
* via the `definition` "CatalogSelectionWrongKind".
|
|
7079
|
+
*/
|
|
7080
|
+
/** @experimental */
|
|
7081
|
+
export interface CatalogSelectionWrongKind {
|
|
7082
|
+
/**
|
|
7083
|
+
* Discriminator for this typed selection rejection
|
|
7084
|
+
*/
|
|
7085
|
+
kind: "wrong-kind";
|
|
7086
|
+
/**
|
|
7087
|
+
* Human-readable explanation safe to surface. Never contains the presented reference or private candidate state.
|
|
7088
|
+
*/
|
|
7089
|
+
message: string;
|
|
7090
|
+
}
|
|
6450
7091
|
/**
|
|
6451
7092
|
* No transport this runtime can use is available for the requested server.
|
|
6452
7093
|
*
|
|
@@ -9656,8 +10297,20 @@ export interface InstalledPluginInfo {
|
|
|
9656
10297
|
* 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
10298
|
*/
|
|
9658
10299
|
source?: string;
|
|
9659
|
-
|
|
9660
|
-
|
|
10300
|
+
/**
|
|
10301
|
+
* Whether enterprise managed settings control this plugin's enabled state.
|
|
10302
|
+
*/
|
|
10303
|
+
managed?: boolean;
|
|
10304
|
+
/**
|
|
10305
|
+
* The enabled state required by enterprise managed settings, when this plugin spec is managed.
|
|
10306
|
+
*/
|
|
10307
|
+
managedDesiredEnabled?: boolean;
|
|
10308
|
+
/**
|
|
10309
|
+
* 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.
|
|
10310
|
+
*/
|
|
10311
|
+
installed?: boolean;
|
|
10312
|
+
}
|
|
10313
|
+
/**
|
|
9661
10314
|
* Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path.
|
|
9662
10315
|
*
|
|
9663
10316
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
@@ -10291,6 +10944,14 @@ export interface MarketplaceInfo {
|
|
|
10291
10944
|
* True when this is a default marketplace shipped with the runtime. Defaults are not removable.
|
|
10292
10945
|
*/
|
|
10293
10946
|
isDefault?: boolean;
|
|
10947
|
+
/**
|
|
10948
|
+
* Whether enterprise managed settings provide and control this marketplace entry.
|
|
10949
|
+
*/
|
|
10950
|
+
managed?: boolean;
|
|
10951
|
+
/**
|
|
10952
|
+
* 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.
|
|
10953
|
+
*/
|
|
10954
|
+
available?: boolean;
|
|
10294
10955
|
}
|
|
10295
10956
|
/**
|
|
10296
10957
|
* All registered marketplaces, including built-in defaults.
|
|
@@ -10707,6 +11368,10 @@ export interface McpServerConfigStdio {
|
|
|
10707
11368
|
* Timeout in milliseconds for tool discovery and tool calls.
|
|
10708
11369
|
*/
|
|
10709
11370
|
timeout?: number;
|
|
11371
|
+
/**
|
|
11372
|
+
* 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.
|
|
11373
|
+
*/
|
|
11374
|
+
slowConnectionThresholdMs?: number;
|
|
10710
11375
|
oidc?: McpServerAuthConfig;
|
|
10711
11376
|
auth?: McpServerAuthConfig;
|
|
10712
11377
|
deferTools?: McpServerConfigDeferTools;
|
|
@@ -10828,6 +11493,10 @@ export interface McpServerConfigHttp {
|
|
|
10828
11493
|
* Timeout in milliseconds for tool discovery and tool calls.
|
|
10829
11494
|
*/
|
|
10830
11495
|
timeout?: number;
|
|
11496
|
+
/**
|
|
11497
|
+
* 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.
|
|
11498
|
+
*/
|
|
11499
|
+
slowConnectionThresholdMs?: number;
|
|
10831
11500
|
oidc?: McpServerAuthConfig;
|
|
10832
11501
|
auth?: McpServerAuthConfig;
|
|
10833
11502
|
deferTools?: McpServerConfigDeferTools;
|
|
@@ -11252,7 +11921,7 @@ export interface McpInstallPlan {
|
|
|
11252
11921
|
target: McpPlanTarget;
|
|
11253
11922
|
policy: McpPlanPolicyResult;
|
|
11254
11923
|
/**
|
|
11255
|
-
*
|
|
11924
|
+
* 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
11925
|
*/
|
|
11257
11926
|
configurationChanges: McpPlanConfigurationChange[];
|
|
11258
11927
|
/**
|
|
@@ -11260,7 +11929,7 @@ export interface McpInstallPlan {
|
|
|
11260
11929
|
*/
|
|
11261
11930
|
reloadRequired: boolean;
|
|
11262
11931
|
/**
|
|
11263
|
-
*
|
|
11932
|
+
* 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
11933
|
*/
|
|
11265
11934
|
requiresInteractiveConfiguration: boolean;
|
|
11266
11935
|
}
|
|
@@ -11492,7 +12161,7 @@ export interface McpPlanPolicyResult {
|
|
|
11492
12161
|
reason?: string;
|
|
11493
12162
|
}
|
|
11494
12163
|
/**
|
|
11495
|
-
*
|
|
12164
|
+
* 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
12165
|
*
|
|
11497
12166
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
11498
12167
|
* via the `definition` "McpPlanConfigurationChange".
|
|
@@ -11776,7 +12445,7 @@ export interface McpPlanInstallSourceCandidate {
|
|
|
11776
12445
|
*/
|
|
11777
12446
|
candidateHandle: string;
|
|
11778
12447
|
/**
|
|
11779
|
-
* The runtime- or authority-minted `searchId` returned with the search that produced this candidate.
|
|
12448
|
+
* 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
12449
|
*/
|
|
11781
12450
|
searchId: string;
|
|
11782
12451
|
}
|
|
@@ -12882,6 +13551,7 @@ export interface ModelApplyStartupOverlayRequest {
|
|
|
12882
13551
|
* 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
13552
|
*/
|
|
12884
13553
|
policyHelperModel?: string;
|
|
13554
|
+
autoTier?: AutoTier;
|
|
12885
13555
|
/**
|
|
12886
13556
|
* Model selected by repository settings, when configured.
|
|
12887
13557
|
*/
|
|
@@ -13211,6 +13881,10 @@ export interface ModelSwitchToRequest {
|
|
|
13211
13881
|
*/
|
|
13212
13882
|
/** @experimental */
|
|
13213
13883
|
export interface ModelSwitchToResult {
|
|
13884
|
+
/**
|
|
13885
|
+
* Stable queue item identifier when this request was enqueued. Remains present if the item drains before the response is returned.
|
|
13886
|
+
*/
|
|
13887
|
+
queueId?: string;
|
|
13214
13888
|
/**
|
|
13215
13889
|
* Currently active model identifier after the switch
|
|
13216
13890
|
*/
|
|
@@ -13519,6 +14193,10 @@ export interface PendingPermissionRequest {
|
|
|
13519
14193
|
*/
|
|
13520
14194
|
requestId: string;
|
|
13521
14195
|
request: PermissionPromptRequest;
|
|
14196
|
+
/**
|
|
14197
|
+
* Permission-recovery episode that authorized this request to surface for interactive attention
|
|
14198
|
+
*/
|
|
14199
|
+
recoveryEpisodeId?: string;
|
|
13522
14200
|
}
|
|
13523
14201
|
/**
|
|
13524
14202
|
* List of pending permission requests reconstructed from event history.
|
|
@@ -15168,6 +15846,30 @@ export interface Plugin {
|
|
|
15168
15846
|
* Whether the plugin is currently enabled
|
|
15169
15847
|
*/
|
|
15170
15848
|
enabled: boolean;
|
|
15849
|
+
/**
|
|
15850
|
+
* Opaque stable identity for a direct plugin source.
|
|
15851
|
+
*/
|
|
15852
|
+
directSourceId?: string;
|
|
15853
|
+
/**
|
|
15854
|
+
* Absolute marketplace directory for a live plugin.
|
|
15855
|
+
*/
|
|
15856
|
+
installedFrom?: string;
|
|
15857
|
+
/**
|
|
15858
|
+
* Runtime plugin provenance, such as "builtin".
|
|
15859
|
+
*/
|
|
15860
|
+
source?: string;
|
|
15861
|
+
/**
|
|
15862
|
+
* Whether enterprise managed settings control this plugin.
|
|
15863
|
+
*/
|
|
15864
|
+
managed?: boolean;
|
|
15865
|
+
/**
|
|
15866
|
+
* Enabled state required by enterprise managed settings.
|
|
15867
|
+
*/
|
|
15868
|
+
managedDesiredEnabled?: boolean;
|
|
15869
|
+
/**
|
|
15870
|
+
* Whether this managed desired plugin has an installed or live record.
|
|
15871
|
+
*/
|
|
15872
|
+
installed?: boolean;
|
|
15171
15873
|
}
|
|
15172
15874
|
/**
|
|
15173
15875
|
* Result of installing a plugin.
|
|
@@ -16212,6 +16914,36 @@ export interface PushAttachmentBlob {
|
|
|
16212
16914
|
*/
|
|
16213
16915
|
displayName?: string;
|
|
16214
16916
|
}
|
|
16917
|
+
/**
|
|
16918
|
+
* Append to one pending steering message without changing its identity or delivery position.
|
|
16919
|
+
*
|
|
16920
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
16921
|
+
* via the `definition` "QueueAppendSteeringRequest".
|
|
16922
|
+
*/
|
|
16923
|
+
/** @experimental */
|
|
16924
|
+
export interface QueueAppendSteeringRequest {
|
|
16925
|
+
/**
|
|
16926
|
+
* Message identity returned by send, not the queue item id. Only unclaimed user steering messages are eligible.
|
|
16927
|
+
*/
|
|
16928
|
+
messageId: string;
|
|
16929
|
+
/**
|
|
16930
|
+
* Expected current prompt, including any previous appends. The runtime applies plan-mode normalization before comparing and refuses a changed message.
|
|
16931
|
+
*/
|
|
16932
|
+
expectedPrompt: string;
|
|
16933
|
+
agentMode: SendAgentMode;
|
|
16934
|
+
/**
|
|
16935
|
+
* Text to append after a blank line.
|
|
16936
|
+
*/
|
|
16937
|
+
prompt: string;
|
|
16938
|
+
/**
|
|
16939
|
+
* Display text to append to the existing preview after a blank line.
|
|
16940
|
+
*/
|
|
16941
|
+
displayPrompt: string;
|
|
16942
|
+
/**
|
|
16943
|
+
* Attachments to add after the message's existing attachments. An empty list preserves the existing attachments.
|
|
16944
|
+
*/
|
|
16945
|
+
attachments: Attachment[];
|
|
16946
|
+
}
|
|
16215
16947
|
/**
|
|
16216
16948
|
* Inputs for starting a deferred-idle drain.
|
|
16217
16949
|
*
|
|
@@ -16590,6 +17322,10 @@ export interface QueueSetDrainPausedRequest {
|
|
|
16590
17322
|
*/
|
|
16591
17323
|
/** @experimental */
|
|
16592
17324
|
export interface QueueSnapshotResult {
|
|
17325
|
+
/**
|
|
17326
|
+
* Queue item identifier of a model switch that has been dequeued but not yet applied.
|
|
17327
|
+
*/
|
|
17328
|
+
inFlightModelChangeId?: string;
|
|
16593
17329
|
/**
|
|
16594
17330
|
* User-facing pending items in FIFO order.
|
|
16595
17331
|
*/
|
|
@@ -16641,6 +17377,23 @@ export interface QueueUpdateTextResult {
|
|
|
16641
17377
|
*/
|
|
16642
17378
|
updated: boolean;
|
|
16643
17379
|
}
|
|
17380
|
+
/**
|
|
17381
|
+
* Conditional withdrawal of a single user message, before the runtime claims it for delivery.
|
|
17382
|
+
*
|
|
17383
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
17384
|
+
* via the `definition` "QueueWithdrawMessageRequest".
|
|
17385
|
+
*/
|
|
17386
|
+
/** @experimental */
|
|
17387
|
+
export interface QueueWithdrawMessageRequest {
|
|
17388
|
+
/**
|
|
17389
|
+
* Message identity returned by send, not the queue item id. Batch messages are not eligible.
|
|
17390
|
+
*/
|
|
17391
|
+
messageId: string;
|
|
17392
|
+
/**
|
|
17393
|
+
* The prompt originally sent. A message edited since submission is not withdrawn, so an obsolete draft cannot replace the edit.
|
|
17394
|
+
*/
|
|
17395
|
+
expectedPrompt: string;
|
|
17396
|
+
}
|
|
16644
17397
|
/**
|
|
16645
17398
|
* Event type to register consumer interest for, used by runtime gating logic.
|
|
16646
17399
|
*
|
|
@@ -18134,7 +18887,7 @@ export interface SessionFsSetProviderCapabilities {
|
|
|
18134
18887
|
sqlite?: boolean;
|
|
18135
18888
|
}
|
|
18136
18889
|
/**
|
|
18137
|
-
* Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider.
|
|
18890
|
+
* 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
18891
|
*
|
|
18139
18892
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
18140
18893
|
* via the `definition` "SessionFsSetProviderRequest".
|
|
@@ -18142,7 +18895,7 @@ export interface SessionFsSetProviderCapabilities {
|
|
|
18142
18895
|
/** @experimental */
|
|
18143
18896
|
export interface SessionFsSetProviderRequest {
|
|
18144
18897
|
/**
|
|
18145
|
-
*
|
|
18898
|
+
* 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
18899
|
*/
|
|
18147
18900
|
initialCwd: string;
|
|
18148
18901
|
/**
|
|
@@ -18612,7 +19365,7 @@ export interface SessionLoadDeferredRepoHooksResult {
|
|
|
18612
19365
|
/** @experimental */
|
|
18613
19366
|
export interface SessionManagedPermissions {
|
|
18614
19367
|
/**
|
|
18615
|
-
* When set to `disable`, prevents bypass/allow-all permission modes.
|
|
19368
|
+
* 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
19369
|
*/
|
|
18617
19370
|
disableBypassPermissionsMode?: string;
|
|
18618
19371
|
/**
|
|
@@ -18696,6 +19449,7 @@ export interface SessionMetadataSnapshot {
|
|
|
18696
19449
|
* Current session limits, or null when no limits are active
|
|
18697
19450
|
*/
|
|
18698
19451
|
sessionLimits: SessionLimitsConfig | null;
|
|
19452
|
+
indexedSearch?: IndexedSearchState;
|
|
18699
19453
|
/**
|
|
18700
19454
|
* 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
19455
|
*/
|
|
@@ -19328,6 +20082,45 @@ export interface SessionsOpenProgress {
|
|
|
19328
20082
|
*/
|
|
19329
20083
|
message?: string;
|
|
19330
20084
|
}
|
|
20085
|
+
/**
|
|
20086
|
+
* Plugin names (or specs) to disable in the session's authoritative working directory.
|
|
20087
|
+
*
|
|
20088
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
20089
|
+
* via the `definition` "SessionPluginsDisableRequest".
|
|
20090
|
+
*/
|
|
20091
|
+
/** @experimental */
|
|
20092
|
+
export interface SessionPluginsDisableRequest {
|
|
20093
|
+
/**
|
|
20094
|
+
* 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.
|
|
20095
|
+
*/
|
|
20096
|
+
names: string[];
|
|
20097
|
+
}
|
|
20098
|
+
/**
|
|
20099
|
+
* Plugin names (or specs) to enable in the session's authoritative working directory.
|
|
20100
|
+
*
|
|
20101
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
20102
|
+
* via the `definition` "SessionPluginsEnableRequest".
|
|
20103
|
+
*/
|
|
20104
|
+
/** @experimental */
|
|
20105
|
+
export interface SessionPluginsEnableRequest {
|
|
20106
|
+
/**
|
|
20107
|
+
* 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.
|
|
20108
|
+
*/
|
|
20109
|
+
names: string[];
|
|
20110
|
+
}
|
|
20111
|
+
/**
|
|
20112
|
+
* Plugin source resolved relative to the session's authoritative working directory.
|
|
20113
|
+
*
|
|
20114
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
20115
|
+
* via the `definition` "SessionPluginsInstallRequest".
|
|
20116
|
+
*/
|
|
20117
|
+
/** @experimental */
|
|
20118
|
+
export interface SessionPluginsInstallRequest {
|
|
20119
|
+
/**
|
|
20120
|
+
* 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.
|
|
20121
|
+
*/
|
|
20122
|
+
source: string;
|
|
20123
|
+
}
|
|
19331
20124
|
/**
|
|
19332
20125
|
* Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag.
|
|
19333
20126
|
*
|
|
@@ -23131,155 +23924,1118 @@ export interface VisibilitySetResult {
|
|
|
23131
23924
|
shareUrl?: string;
|
|
23132
23925
|
}
|
|
23133
23926
|
/**
|
|
23134
|
-
*
|
|
23927
|
+
* Parameters for cooperatively aborting a workflow body.
|
|
23135
23928
|
*
|
|
23136
23929
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23137
|
-
* via the `definition` "
|
|
23930
|
+
* via the `definition` "WorkflowAbortRequest".
|
|
23138
23931
|
*/
|
|
23139
23932
|
/** @experimental */
|
|
23140
|
-
export interface
|
|
23141
|
-
/**
|
|
23142
|
-
* Path to the changed file, relative to the workspace root when the file lives under it. A file changed outside the workspace root keeps a `../`-relative path, or an absolute path when no relative path exists (for example a different Windows drive).
|
|
23143
|
-
*/
|
|
23144
|
-
path: string;
|
|
23933
|
+
export interface WorkflowAbortRequest {
|
|
23145
23934
|
/**
|
|
23146
|
-
*
|
|
23935
|
+
* Target session identifier
|
|
23147
23936
|
*/
|
|
23148
|
-
|
|
23149
|
-
changeType: WorkspaceDiffFileChangeType;
|
|
23937
|
+
sessionId: string;
|
|
23150
23938
|
/**
|
|
23151
|
-
*
|
|
23939
|
+
* Workflow run identifier.
|
|
23152
23940
|
*/
|
|
23153
|
-
|
|
23941
|
+
runId: string;
|
|
23154
23942
|
/**
|
|
23155
|
-
*
|
|
23943
|
+
* Opaque token identifying the execution attempt to abort.
|
|
23156
23944
|
*/
|
|
23157
|
-
|
|
23945
|
+
executionToken: string;
|
|
23158
23946
|
}
|
|
23159
23947
|
/**
|
|
23160
|
-
*
|
|
23948
|
+
* Acknowledgement that a workflow request was accepted.
|
|
23161
23949
|
*
|
|
23162
23950
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23163
|
-
* via the `definition` "
|
|
23951
|
+
* via the `definition` "WorkflowAckResult".
|
|
23164
23952
|
*/
|
|
23165
23953
|
/** @experimental */
|
|
23166
|
-
export interface
|
|
23167
|
-
requestedMode: WorkspaceDiffMode;
|
|
23168
|
-
mode: WorkspaceDiffMode;
|
|
23169
|
-
/**
|
|
23170
|
-
* Changed files and their unified diffs.
|
|
23171
|
-
*/
|
|
23172
|
-
changes: WorkspaceDiffFileChange[];
|
|
23173
|
-
/**
|
|
23174
|
-
* Default branch used for a branch diff, when branch mode was requested.
|
|
23175
|
-
*/
|
|
23176
|
-
baseBranch?: string;
|
|
23177
|
-
/**
|
|
23178
|
-
* Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable.
|
|
23179
|
-
*/
|
|
23180
|
-
isFallback: boolean;
|
|
23181
|
-
unavailableReason?: HistoryRewindUnavailableReason;
|
|
23954
|
+
export interface WorkflowAckResult {
|
|
23182
23955
|
}
|
|
23183
23956
|
/**
|
|
23184
|
-
*
|
|
23957
|
+
* Options for one workflow-scoped subagent call.
|
|
23185
23958
|
*
|
|
23186
23959
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23187
|
-
* via the `definition` "
|
|
23960
|
+
* via the `definition` "WorkflowAgentOptions".
|
|
23188
23961
|
*/
|
|
23189
23962
|
/** @experimental */
|
|
23190
|
-
export interface
|
|
23963
|
+
export interface WorkflowAgentOptions {
|
|
23191
23964
|
/**
|
|
23192
|
-
*
|
|
23965
|
+
* Optional label distinguishing otherwise identical memoized agent calls.
|
|
23193
23966
|
*/
|
|
23194
|
-
|
|
23967
|
+
label?: string;
|
|
23195
23968
|
/**
|
|
23196
|
-
*
|
|
23969
|
+
* Optional JSON Schema for structured agent output.
|
|
23197
23970
|
*/
|
|
23198
|
-
|
|
23971
|
+
schema?: JsonValue;
|
|
23972
|
+
/**
|
|
23973
|
+
* Optional model identifier for the subagent.
|
|
23974
|
+
*/
|
|
23975
|
+
model?: string;
|
|
23976
|
+
/**
|
|
23977
|
+
* Optional reasoning effort override for the subagent.
|
|
23978
|
+
*/
|
|
23979
|
+
reasoningEffort?: string;
|
|
23980
|
+
contextTier?: ContextTier;
|
|
23981
|
+
/**
|
|
23982
|
+
* Optional built-in or custom agent name whose definition configures the subagent.
|
|
23983
|
+
*/
|
|
23984
|
+
agent?: string;
|
|
23199
23985
|
}
|
|
23200
23986
|
/**
|
|
23201
|
-
*
|
|
23987
|
+
* Parameters for one workflow-scoped subagent call.
|
|
23202
23988
|
*
|
|
23203
23989
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23204
|
-
* via the `definition` "
|
|
23990
|
+
* via the `definition` "WorkflowAgentRequest".
|
|
23205
23991
|
*/
|
|
23206
23992
|
/** @experimental */
|
|
23207
|
-
export interface
|
|
23993
|
+
export interface WorkflowAgentRequest {
|
|
23208
23994
|
/**
|
|
23209
|
-
*
|
|
23995
|
+
* Workflow run identifier that owns the subagent.
|
|
23210
23996
|
*/
|
|
23211
|
-
|
|
23997
|
+
workflowRunId: string;
|
|
23212
23998
|
/**
|
|
23213
|
-
*
|
|
23999
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
23214
24000
|
*/
|
|
23215
|
-
|
|
23216
|
-
|
|
24001
|
+
executionToken: string;
|
|
24002
|
+
/**
|
|
24003
|
+
* Prompt to send to the subagent.
|
|
24004
|
+
*/
|
|
24005
|
+
prompt: string;
|
|
24006
|
+
opts: WorkflowAgentOptions;
|
|
23217
24007
|
}
|
|
23218
24008
|
/**
|
|
23219
|
-
*
|
|
24009
|
+
* Result of one workflow-scoped subagent call.
|
|
23220
24010
|
*
|
|
23221
24011
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23222
|
-
* via the `definition` "
|
|
24012
|
+
* via the `definition` "WorkflowAgentResult".
|
|
23223
24013
|
*/
|
|
23224
24014
|
/** @experimental */
|
|
23225
|
-
export interface
|
|
24015
|
+
export interface WorkflowAgentResult {
|
|
23226
24016
|
/**
|
|
23227
|
-
*
|
|
24017
|
+
* Agent result, omitted when the agent produced no result.
|
|
23228
24018
|
*/
|
|
23229
|
-
|
|
24019
|
+
result?: JsonValue;
|
|
23230
24020
|
}
|
|
23231
24021
|
/**
|
|
23232
|
-
*
|
|
24022
|
+
* Prompt-safe durable identity and live status for a direct workflow agent.
|
|
23233
24023
|
*
|
|
23234
24024
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23235
|
-
* via the `definition` "
|
|
24025
|
+
* via the `definition` "WorkflowAgentSummary".
|
|
23236
24026
|
*/
|
|
23237
24027
|
/** @experimental */
|
|
23238
|
-
export interface
|
|
24028
|
+
export interface WorkflowAgentSummary {
|
|
23239
24029
|
/**
|
|
23240
|
-
*
|
|
24030
|
+
* Stable direct-agent identifier.
|
|
23241
24031
|
*/
|
|
23242
|
-
|
|
24032
|
+
agentId: string;
|
|
23243
24033
|
/**
|
|
23244
|
-
*
|
|
24034
|
+
* Tool-call identifier that launched the agent.
|
|
23245
24035
|
*/
|
|
23246
|
-
|
|
24036
|
+
toolCallId: string;
|
|
23247
24037
|
/**
|
|
23248
|
-
*
|
|
24038
|
+
* Owning workflow run identifier.
|
|
23249
24039
|
*/
|
|
23250
|
-
|
|
24040
|
+
runId: string;
|
|
24041
|
+
/**
|
|
24042
|
+
* Phase identifier active when the agent was launched, or null.
|
|
24043
|
+
*/
|
|
24044
|
+
phaseId: string | null;
|
|
24045
|
+
/**
|
|
24046
|
+
* Friendly, non-unique name intended for display
|
|
24047
|
+
*/
|
|
24048
|
+
label: string;
|
|
24049
|
+
/**
|
|
24050
|
+
* Friendly, non-unique name intended for display
|
|
24051
|
+
*/
|
|
24052
|
+
displayName?: string;
|
|
24053
|
+
/**
|
|
24054
|
+
* Registered agent type.
|
|
24055
|
+
*/
|
|
24056
|
+
agentType: string;
|
|
24057
|
+
/**
|
|
24058
|
+
* Current durable or live agent status.
|
|
24059
|
+
*/
|
|
24060
|
+
status: string;
|
|
24061
|
+
/**
|
|
24062
|
+
* Model requested when the agent was launched.
|
|
24063
|
+
*/
|
|
24064
|
+
requestedModel?: string;
|
|
24065
|
+
/**
|
|
24066
|
+
* Concrete model resolved for the agent.
|
|
24067
|
+
*/
|
|
24068
|
+
resolvedModel?: string;
|
|
24069
|
+
/**
|
|
24070
|
+
* Epoch milliseconds when the agent started.
|
|
24071
|
+
*/
|
|
24072
|
+
startedAt?: number;
|
|
24073
|
+
/**
|
|
24074
|
+
* Epoch milliseconds when the agent completed.
|
|
24075
|
+
*/
|
|
24076
|
+
completedAt?: number;
|
|
24077
|
+
/**
|
|
24078
|
+
* Accumulated active agent time in milliseconds.
|
|
24079
|
+
*/
|
|
24080
|
+
activeMs: number;
|
|
24081
|
+
/**
|
|
24082
|
+
* Prompt-safe live activity text.
|
|
24083
|
+
*/
|
|
24084
|
+
activity?: string;
|
|
23251
24085
|
}
|
|
23252
24086
|
/**
|
|
23253
|
-
*
|
|
24087
|
+
* Parameters for cancelling a workflow run.
|
|
23254
24088
|
*
|
|
23255
24089
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23256
|
-
* via the `definition` "
|
|
24090
|
+
* via the `definition` "WorkflowCancelRequest".
|
|
23257
24091
|
*/
|
|
23258
24092
|
/** @experimental */
|
|
23259
|
-
export interface
|
|
23260
|
-
/**
|
|
23261
|
-
* Slash-separated relative path within the workspace files directory
|
|
23262
|
-
*/
|
|
23263
|
-
path: string;
|
|
24093
|
+
export interface WorkflowCancelRequest {
|
|
23264
24094
|
/**
|
|
23265
|
-
*
|
|
24095
|
+
* Workflow run identifier.
|
|
23266
24096
|
*/
|
|
23267
|
-
|
|
24097
|
+
runId: string;
|
|
23268
24098
|
}
|
|
23269
24099
|
/**
|
|
23270
|
-
*
|
|
24100
|
+
* Current workflow phase identity.
|
|
23271
24101
|
*
|
|
23272
24102
|
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
23273
|
-
* via the `definition` "
|
|
24103
|
+
* via the `definition` "WorkflowCurrentPhase".
|
|
23274
24104
|
*/
|
|
23275
24105
|
/** @experimental */
|
|
23276
|
-
export interface
|
|
24106
|
+
export interface WorkflowCurrentPhase {
|
|
23277
24107
|
/**
|
|
23278
|
-
*
|
|
24108
|
+
* Current phase identifier.
|
|
23279
24109
|
*/
|
|
23280
|
-
|
|
24110
|
+
id: string;
|
|
23281
24111
|
/**
|
|
23282
|
-
*
|
|
24112
|
+
* Zero-based declared phase ordinal, or null for an undeclared phase.
|
|
24113
|
+
*/
|
|
24114
|
+
ordinal: number | null;
|
|
24115
|
+
}
|
|
24116
|
+
/**
|
|
24117
|
+
* Declared or approved workflow resource ceilings.
|
|
24118
|
+
*
|
|
24119
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24120
|
+
* via the `definition` "WorkflowDeclaredLimits".
|
|
24121
|
+
*/
|
|
24122
|
+
/** @experimental */
|
|
24123
|
+
export interface WorkflowDeclaredLimits {
|
|
24124
|
+
/**
|
|
24125
|
+
* Maximum concurrently active subagents.
|
|
24126
|
+
*/
|
|
24127
|
+
maxConcurrentSubagents?: number;
|
|
24128
|
+
/**
|
|
24129
|
+
* Maximum total subagents spawned by the run.
|
|
24130
|
+
*/
|
|
24131
|
+
maxTotalSubagents?: number;
|
|
24132
|
+
/**
|
|
24133
|
+
* Maximum accumulated active execution time in seconds.
|
|
24134
|
+
*/
|
|
24135
|
+
timeoutSeconds?: number;
|
|
24136
|
+
/**
|
|
24137
|
+
* Maximum AI credits consumed by subagents and descendants.
|
|
24138
|
+
*/
|
|
24139
|
+
maxAiCredits?: number;
|
|
24140
|
+
}
|
|
24141
|
+
/**
|
|
24142
|
+
* Parameters sent to the owning extension to execute a workflow closure.
|
|
24143
|
+
*
|
|
24144
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24145
|
+
* via the `definition` "WorkflowExecuteRequest".
|
|
24146
|
+
*/
|
|
24147
|
+
/** @experimental */
|
|
24148
|
+
export interface WorkflowExecuteRequest {
|
|
24149
|
+
/**
|
|
24150
|
+
* Target session identifier
|
|
24151
|
+
*/
|
|
24152
|
+
sessionId: string;
|
|
24153
|
+
/**
|
|
24154
|
+
* Registered workflow name.
|
|
24155
|
+
*/
|
|
24156
|
+
name: string;
|
|
24157
|
+
/**
|
|
24158
|
+
* Workflow run identifier.
|
|
24159
|
+
*/
|
|
24160
|
+
runId: string;
|
|
24161
|
+
/**
|
|
24162
|
+
* Opaque token identifying this workflow execution attempt.
|
|
24163
|
+
*/
|
|
24164
|
+
executionToken: string;
|
|
24165
|
+
/**
|
|
24166
|
+
* Workflow input value.
|
|
24167
|
+
*/
|
|
24168
|
+
args: JsonValue;
|
|
24169
|
+
}
|
|
24170
|
+
/**
|
|
24171
|
+
* Result returned by an extension workflow closure.
|
|
24172
|
+
*
|
|
24173
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24174
|
+
* via the `definition` "WorkflowExecuteResult".
|
|
24175
|
+
*/
|
|
24176
|
+
/** @experimental */
|
|
24177
|
+
export interface WorkflowExecuteResult {
|
|
24178
|
+
/**
|
|
24179
|
+
* Workflow result value.
|
|
24180
|
+
*/
|
|
24181
|
+
result?: JsonValue;
|
|
24182
|
+
}
|
|
24183
|
+
/**
|
|
24184
|
+
* Parameters for paging workflow progress.
|
|
24185
|
+
*
|
|
24186
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24187
|
+
* via the `definition` "WorkflowGetRunProgressRequest".
|
|
24188
|
+
*/
|
|
24189
|
+
/** @experimental */
|
|
24190
|
+
export interface WorkflowGetRunProgressRequest {
|
|
24191
|
+
/**
|
|
24192
|
+
* Workflow run identifier.
|
|
24193
|
+
*/
|
|
24194
|
+
runId: string;
|
|
24195
|
+
/**
|
|
24196
|
+
* Optional phase identifier used to scope records and cursors.
|
|
24197
|
+
*/
|
|
24198
|
+
phaseId?: string;
|
|
24199
|
+
/**
|
|
24200
|
+
* Exclusive forward cursor.
|
|
24201
|
+
*/
|
|
24202
|
+
afterSeq?: number;
|
|
24203
|
+
/**
|
|
24204
|
+
* Exclusive backward cursor.
|
|
24205
|
+
*/
|
|
24206
|
+
beforeSeq?: number;
|
|
24207
|
+
/**
|
|
24208
|
+
* Maximum records to return. Defaults to 200 and is capped at 500.
|
|
24209
|
+
*/
|
|
24210
|
+
limit?: number;
|
|
24211
|
+
}
|
|
24212
|
+
/**
|
|
24213
|
+
* Parameters for retrieving a workflow run.
|
|
24214
|
+
*
|
|
24215
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24216
|
+
* via the `definition` "WorkflowGetRunRequest".
|
|
24217
|
+
*/
|
|
24218
|
+
/** @experimental */
|
|
24219
|
+
export interface WorkflowGetRunRequest {
|
|
24220
|
+
/**
|
|
24221
|
+
* Workflow run identifier.
|
|
24222
|
+
*/
|
|
24223
|
+
runId: string;
|
|
24224
|
+
}
|
|
24225
|
+
/**
|
|
24226
|
+
* Parameters for reading a workflow journal entry.
|
|
24227
|
+
*
|
|
24228
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24229
|
+
* via the `definition` "WorkflowJournalGetRequest".
|
|
24230
|
+
*/
|
|
24231
|
+
/** @experimental */
|
|
24232
|
+
export interface WorkflowJournalGetRequest {
|
|
24233
|
+
/**
|
|
24234
|
+
* Workflow run identifier.
|
|
24235
|
+
*/
|
|
24236
|
+
runId: string;
|
|
24237
|
+
/**
|
|
24238
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
24239
|
+
*/
|
|
24240
|
+
executionToken: string;
|
|
24241
|
+
/**
|
|
24242
|
+
* Namespaced journal key.
|
|
24243
|
+
*/
|
|
24244
|
+
key: string;
|
|
24245
|
+
}
|
|
24246
|
+
/**
|
|
24247
|
+
* Result of reading a workflow journal entry.
|
|
24248
|
+
*
|
|
24249
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24250
|
+
* via the `definition` "WorkflowJournalGetResult".
|
|
24251
|
+
*/
|
|
24252
|
+
/** @experimental */
|
|
24253
|
+
export interface WorkflowJournalGetResult {
|
|
24254
|
+
/**
|
|
24255
|
+
* Whether the journal contained the requested key.
|
|
24256
|
+
*/
|
|
24257
|
+
hit: boolean;
|
|
24258
|
+
/**
|
|
24259
|
+
* Cached JSON result. The hit field distinguishes a cached JSON null from a miss.
|
|
24260
|
+
*/
|
|
24261
|
+
resultJson?: JsonValue;
|
|
24262
|
+
}
|
|
24263
|
+
/**
|
|
24264
|
+
* Parameters for storing a workflow journal entry.
|
|
24265
|
+
*
|
|
24266
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24267
|
+
* via the `definition` "WorkflowJournalPutRequest".
|
|
24268
|
+
*/
|
|
24269
|
+
/** @experimental */
|
|
24270
|
+
export interface WorkflowJournalPutRequest {
|
|
24271
|
+
/**
|
|
24272
|
+
* Workflow run identifier.
|
|
24273
|
+
*/
|
|
24274
|
+
runId: string;
|
|
24275
|
+
/**
|
|
24276
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
24277
|
+
*/
|
|
24278
|
+
executionToken: string;
|
|
24279
|
+
/**
|
|
24280
|
+
* Namespaced journal key.
|
|
24281
|
+
*/
|
|
24282
|
+
key: string;
|
|
24283
|
+
/**
|
|
24284
|
+
* JSON result to memoize.
|
|
24285
|
+
*/
|
|
24286
|
+
resultJson: JsonValue;
|
|
24287
|
+
}
|
|
24288
|
+
/**
|
|
24289
|
+
* Parameters for paging workflow runs.
|
|
24290
|
+
*
|
|
24291
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24292
|
+
* via the `definition` "WorkflowListRunsRequest".
|
|
24293
|
+
*/
|
|
24294
|
+
/** @experimental */
|
|
24295
|
+
export interface WorkflowListRunsRequest {
|
|
24296
|
+
/**
|
|
24297
|
+
* Exclusive forward cursor.
|
|
24298
|
+
*/
|
|
24299
|
+
afterSeq?: number;
|
|
24300
|
+
/**
|
|
24301
|
+
* Exclusive backward cursor.
|
|
24302
|
+
*/
|
|
24303
|
+
beforeSeq?: number;
|
|
24304
|
+
/**
|
|
24305
|
+
* Maximum terminal runs to return. Defaults to 200 and is capped at 500.
|
|
24306
|
+
*/
|
|
24307
|
+
limit?: number;
|
|
24308
|
+
}
|
|
24309
|
+
/**
|
|
24310
|
+
* A page of workflow runs in durable creation order.
|
|
24311
|
+
*
|
|
24312
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24313
|
+
* via the `definition` "WorkflowListRunsResult".
|
|
24314
|
+
*/
|
|
24315
|
+
/** @experimental */
|
|
24316
|
+
export interface WorkflowListRunsResult {
|
|
24317
|
+
/**
|
|
24318
|
+
* Workflow run summaries in durable creation order.
|
|
24319
|
+
*/
|
|
24320
|
+
runs: WorkflowRunSummary[];
|
|
24321
|
+
/**
|
|
24322
|
+
* Oldest terminal-run cursor in this page, or null when the terminal window is empty.
|
|
24323
|
+
*/
|
|
24324
|
+
oldestSeq?: number | null;
|
|
24325
|
+
/**
|
|
24326
|
+
* Newest terminal-run cursor in this page, or null when the terminal window is empty.
|
|
24327
|
+
*/
|
|
24328
|
+
newestSeq?: number | null;
|
|
24329
|
+
/**
|
|
24330
|
+
* Whether terminal runs newer than this page exist.
|
|
24331
|
+
*/
|
|
24332
|
+
hasMoreNewer?: boolean;
|
|
24333
|
+
/**
|
|
24334
|
+
* Number of terminal runs older than this page.
|
|
24335
|
+
*/
|
|
24336
|
+
omittedOlder?: number;
|
|
24337
|
+
}
|
|
24338
|
+
/**
|
|
24339
|
+
* Durable workflow run summary with read-time live overlays.
|
|
24340
|
+
*
|
|
24341
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24342
|
+
* via the `definition` "WorkflowRunSummary".
|
|
24343
|
+
*/
|
|
24344
|
+
/** @experimental */
|
|
24345
|
+
export interface WorkflowRunSummary {
|
|
24346
|
+
/**
|
|
24347
|
+
* Workflow run identifier.
|
|
24348
|
+
*/
|
|
24349
|
+
runId: string;
|
|
24350
|
+
/**
|
|
24351
|
+
* Registered workflow name.
|
|
24352
|
+
*/
|
|
24353
|
+
workflowName: string;
|
|
24354
|
+
/**
|
|
24355
|
+
* Human-readable workflow description.
|
|
24356
|
+
*/
|
|
24357
|
+
description: string;
|
|
24358
|
+
status: WorkflowRunStatus;
|
|
24359
|
+
/**
|
|
24360
|
+
* Monotonic durable run revision.
|
|
24361
|
+
*/
|
|
24362
|
+
revision: number;
|
|
24363
|
+
/**
|
|
24364
|
+
* Epoch milliseconds when the run was created.
|
|
24365
|
+
*/
|
|
24366
|
+
createdAt: number;
|
|
24367
|
+
/**
|
|
24368
|
+
* Epoch milliseconds when execution first started, or null before start.
|
|
24369
|
+
*/
|
|
24370
|
+
startedAt: number | null;
|
|
24371
|
+
/**
|
|
24372
|
+
* Epoch milliseconds when the durable run was last updated.
|
|
24373
|
+
*/
|
|
24374
|
+
updatedAt: number;
|
|
24375
|
+
/**
|
|
24376
|
+
* Epoch milliseconds when the run completed, or null while nonterminal.
|
|
24377
|
+
*/
|
|
24378
|
+
completedAt: number | null;
|
|
24379
|
+
/**
|
|
24380
|
+
* Current phase identity, or null before any phase is entered.
|
|
24381
|
+
*/
|
|
24382
|
+
currentPhase: WorkflowCurrentPhase | null;
|
|
24383
|
+
/**
|
|
24384
|
+
* Number of phases declared by the workflow.
|
|
24385
|
+
*/
|
|
24386
|
+
declaredPhaseCount: number;
|
|
24387
|
+
/**
|
|
24388
|
+
* Number of direct workflow agents currently live.
|
|
24389
|
+
*/
|
|
24390
|
+
liveAgentCount: number;
|
|
24391
|
+
/**
|
|
24392
|
+
* Total direct workflow agents spawned across all attempts.
|
|
24393
|
+
*/
|
|
24394
|
+
totalSpawnedAgentCount: number;
|
|
24395
|
+
consumed: WorkflowRunConsumed;
|
|
24396
|
+
declaredLimits: WorkflowDeclaredLimits;
|
|
24397
|
+
/**
|
|
24398
|
+
* Approved effective resource ceilings, or null until approved.
|
|
24399
|
+
*/
|
|
24400
|
+
approved: WorkflowDeclaredLimits | null;
|
|
24401
|
+
/**
|
|
24402
|
+
* Epoch milliseconds when this live-overlay snapshot was observed.
|
|
24403
|
+
*/
|
|
24404
|
+
observedAt: number;
|
|
24405
|
+
/**
|
|
24406
|
+
* Epoch milliseconds when the current active segment started, or null while inactive.
|
|
24407
|
+
*/
|
|
24408
|
+
activeSegmentStartedAt: number | null;
|
|
24409
|
+
/**
|
|
24410
|
+
* Terminal run outcome, or null while nonterminal.
|
|
24411
|
+
*/
|
|
24412
|
+
terminal: WorkflowRunTerminal | null;
|
|
24413
|
+
/**
|
|
24414
|
+
* Whether the durable run state currently passes runtime resume eligibility checks.
|
|
24415
|
+
*/
|
|
24416
|
+
canResume: boolean;
|
|
24417
|
+
}
|
|
24418
|
+
/**
|
|
24419
|
+
* Durable workflow resource consumption.
|
|
24420
|
+
*
|
|
24421
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24422
|
+
* via the `definition` "WorkflowRunConsumed".
|
|
24423
|
+
*/
|
|
24424
|
+
/** @experimental */
|
|
24425
|
+
export interface WorkflowRunConsumed {
|
|
24426
|
+
/**
|
|
24427
|
+
* Accumulated active execution time in milliseconds.
|
|
24428
|
+
*/
|
|
24429
|
+
activeMs: number;
|
|
24430
|
+
/**
|
|
24431
|
+
* Total subagents spawned by the run.
|
|
24432
|
+
*/
|
|
24433
|
+
subagents: number;
|
|
24434
|
+
/**
|
|
24435
|
+
* AI usage consumed by the run in nano-AIU.
|
|
24436
|
+
*/
|
|
24437
|
+
nanoAiu: number;
|
|
24438
|
+
}
|
|
24439
|
+
/**
|
|
24440
|
+
* Prompt-safe terminal workflow outcome.
|
|
24441
|
+
*
|
|
24442
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24443
|
+
* via the `definition` "WorkflowRunTerminal".
|
|
24444
|
+
*/
|
|
24445
|
+
/** @experimental */
|
|
24446
|
+
export interface WorkflowRunTerminal {
|
|
24447
|
+
/**
|
|
24448
|
+
* Human-readable terminal reason.
|
|
24449
|
+
*/
|
|
24450
|
+
reason?: string;
|
|
24451
|
+
failure?: WorkflowRunFailure;
|
|
24452
|
+
/**
|
|
24453
|
+
* Human-readable terminal error.
|
|
24454
|
+
*/
|
|
24455
|
+
error?: string;
|
|
24456
|
+
/**
|
|
24457
|
+
* Prompt-safe preview of the completed result.
|
|
24458
|
+
*/
|
|
24459
|
+
resultPreview?: string;
|
|
24460
|
+
/**
|
|
24461
|
+
* Pause initiator metadata, or null when the run did not pause.
|
|
24462
|
+
*/
|
|
24463
|
+
pauseInfo: WorkflowPauseInfo | null;
|
|
24464
|
+
}
|
|
24465
|
+
/**
|
|
24466
|
+
* One ordered workflow progress line.
|
|
24467
|
+
*
|
|
24468
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24469
|
+
* via the `definition` "WorkflowLogLine".
|
|
24470
|
+
*/
|
|
24471
|
+
/** @experimental */
|
|
24472
|
+
export interface WorkflowLogLine {
|
|
24473
|
+
/**
|
|
24474
|
+
* Monotonic sequence number within the workflow run.
|
|
24475
|
+
*/
|
|
24476
|
+
seq: number;
|
|
24477
|
+
kind: WorkflowLogLineKind;
|
|
24478
|
+
/**
|
|
24479
|
+
* Progress text.
|
|
24480
|
+
*/
|
|
24481
|
+
text: string;
|
|
24482
|
+
}
|
|
24483
|
+
/**
|
|
24484
|
+
* Parameters for recording workflow progress.
|
|
24485
|
+
*
|
|
24486
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24487
|
+
* via the `definition` "WorkflowLogRequest".
|
|
24488
|
+
*/
|
|
24489
|
+
/** @experimental */
|
|
24490
|
+
export interface WorkflowLogRequest {
|
|
24491
|
+
/**
|
|
24492
|
+
* Workflow run identifier.
|
|
24493
|
+
*/
|
|
24494
|
+
runId: string;
|
|
24495
|
+
/**
|
|
24496
|
+
* Opaque token identifying the current workflow execution attempt.
|
|
24497
|
+
*/
|
|
24498
|
+
executionToken: string;
|
|
24499
|
+
/**
|
|
24500
|
+
* Ordered progress lines to append.
|
|
24501
|
+
*/
|
|
24502
|
+
lines: WorkflowLogLine[];
|
|
24503
|
+
}
|
|
24504
|
+
/**
|
|
24505
|
+
* Parameters for an owned durable pause checkpoint.
|
|
24506
|
+
*
|
|
24507
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24508
|
+
* via the `definition` "WorkflowPauseCheckpointRequest".
|
|
24509
|
+
*/
|
|
24510
|
+
/** @experimental */
|
|
24511
|
+
export interface WorkflowPauseCheckpointRequest {
|
|
24512
|
+
/**
|
|
24513
|
+
* Workflow run identifier.
|
|
24514
|
+
*/
|
|
24515
|
+
runId: string;
|
|
24516
|
+
/**
|
|
24517
|
+
* Opaque token identifying the execution attempt that reached the checkpoint.
|
|
24518
|
+
*/
|
|
24519
|
+
executionToken: string;
|
|
24520
|
+
/**
|
|
24521
|
+
* Stable author-defined checkpoint key.
|
|
24522
|
+
*/
|
|
24523
|
+
key: string;
|
|
24524
|
+
}
|
|
24525
|
+
/** @experimental */
|
|
24526
|
+
export interface WorkflowPauseCheckpointResult {
|
|
24527
|
+
action: WorkflowPauseCheckpointAction;
|
|
24528
|
+
}
|
|
24529
|
+
/**
|
|
24530
|
+
* Parameters for pausing a running workflow.
|
|
24531
|
+
*
|
|
24532
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24533
|
+
* via the `definition` "WorkflowPauseRequest".
|
|
24534
|
+
*/
|
|
24535
|
+
/** @experimental */
|
|
24536
|
+
export interface WorkflowPauseRequest {
|
|
24537
|
+
/**
|
|
24538
|
+
* Workflow run identifier.
|
|
24539
|
+
*/
|
|
24540
|
+
runId: string;
|
|
24541
|
+
}
|
|
24542
|
+
/**
|
|
24543
|
+
* Durable lifecycle and timing for one workflow phase.
|
|
24544
|
+
*
|
|
24545
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24546
|
+
* via the `definition` "WorkflowPhaseObservation".
|
|
24547
|
+
*/
|
|
24548
|
+
/** @experimental */
|
|
24549
|
+
export interface WorkflowPhaseObservation {
|
|
24550
|
+
/**
|
|
24551
|
+
* Phase identifier.
|
|
24552
|
+
*/
|
|
24553
|
+
id: string;
|
|
24554
|
+
/**
|
|
24555
|
+
* Zero-based declared phase ordinal, or null for an undeclared phase.
|
|
24556
|
+
*/
|
|
24557
|
+
ordinal: number | null;
|
|
24558
|
+
/**
|
|
24559
|
+
* Human-readable phase title.
|
|
24560
|
+
*/
|
|
24561
|
+
title: string;
|
|
24562
|
+
/**
|
|
24563
|
+
* Optional human-readable phase detail.
|
|
24564
|
+
*/
|
|
24565
|
+
detail?: string;
|
|
24566
|
+
status: WorkflowPhaseStatus;
|
|
24567
|
+
/**
|
|
24568
|
+
* Most recent run attempt that entered this phase, or `0` if the phase has never been entered.
|
|
24569
|
+
*/
|
|
24570
|
+
lastEnteredRunAttempt: number;
|
|
24571
|
+
/**
|
|
24572
|
+
* Number of times execution entered this phase.
|
|
24573
|
+
*/
|
|
24574
|
+
entryCount: number;
|
|
24575
|
+
/**
|
|
24576
|
+
* Epoch milliseconds when this phase first started; for a skipped phase, the synthetic skip timestamp (equal to `completedAt`).
|
|
24577
|
+
*/
|
|
24578
|
+
startedAt?: number;
|
|
24579
|
+
/**
|
|
24580
|
+
* Epoch milliseconds when this phase completed; for a skipped phase, the synthetic skip timestamp (equal to `startedAt`).
|
|
24581
|
+
*/
|
|
24582
|
+
completedAt?: number;
|
|
24583
|
+
/**
|
|
24584
|
+
* Completed active time accumulated by this phase in milliseconds.
|
|
24585
|
+
*/
|
|
24586
|
+
accumulatedActiveMs: number;
|
|
24587
|
+
/**
|
|
24588
|
+
* Current live active time for this phase in milliseconds.
|
|
24589
|
+
*/
|
|
24590
|
+
currentActiveMs: number;
|
|
24591
|
+
/**
|
|
24592
|
+
* Total direct agents associated with this phase.
|
|
24593
|
+
*/
|
|
24594
|
+
totalAgentCount: number;
|
|
24595
|
+
/**
|
|
24596
|
+
* Direct agents in this phase that are currently live.
|
|
24597
|
+
*/
|
|
24598
|
+
liveAgentCount: number;
|
|
24599
|
+
}
|
|
24600
|
+
/**
|
|
24601
|
+
* One durable workflow progress record.
|
|
24602
|
+
*
|
|
24603
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24604
|
+
* via the `definition` "WorkflowProgressLine".
|
|
24605
|
+
*/
|
|
24606
|
+
/** @experimental */
|
|
24607
|
+
export interface WorkflowProgressLine {
|
|
24608
|
+
/**
|
|
24609
|
+
* Global monotonic sequence number within the run.
|
|
24610
|
+
*/
|
|
24611
|
+
seq: number;
|
|
24612
|
+
/**
|
|
24613
|
+
* Resume attempt that emitted this record.
|
|
24614
|
+
*/
|
|
24615
|
+
attempt: number;
|
|
24616
|
+
/**
|
|
24617
|
+
* Phase active when the record was emitted, or null before any phase.
|
|
24618
|
+
*/
|
|
24619
|
+
phaseId: string | null;
|
|
24620
|
+
/**
|
|
24621
|
+
* Epoch milliseconds when the record was persisted.
|
|
24622
|
+
*/
|
|
24623
|
+
recordedAt: number;
|
|
24624
|
+
kind: WorkflowLogLineKind;
|
|
24625
|
+
/**
|
|
24626
|
+
* Prompt-safe progress text.
|
|
24627
|
+
*/
|
|
24628
|
+
text: string;
|
|
24629
|
+
}
|
|
24630
|
+
/**
|
|
24631
|
+
* A bidirectional page of workflow progress.
|
|
24632
|
+
*
|
|
24633
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24634
|
+
* via the `definition` "WorkflowProgressPage".
|
|
24635
|
+
*/
|
|
24636
|
+
/** @experimental */
|
|
24637
|
+
export interface WorkflowProgressPage {
|
|
24638
|
+
/**
|
|
24639
|
+
* Progress records in sequence order.
|
|
24640
|
+
*/
|
|
24641
|
+
records: WorkflowProgressLine[];
|
|
24642
|
+
/**
|
|
24643
|
+
* Oldest sequence number in this page, or null when empty.
|
|
24644
|
+
*/
|
|
24645
|
+
oldestSeq: number | null;
|
|
24646
|
+
/**
|
|
24647
|
+
* Newest sequence number in this page, or null when empty.
|
|
24648
|
+
*/
|
|
24649
|
+
newestSeq: number | null;
|
|
24650
|
+
/**
|
|
24651
|
+
* Whether progress records older than this page exist.
|
|
24652
|
+
*/
|
|
24653
|
+
hasMoreOlder: boolean;
|
|
24654
|
+
/**
|
|
24655
|
+
* Whether progress records newer than this page exist.
|
|
24656
|
+
*/
|
|
24657
|
+
hasMoreNewer: boolean;
|
|
24658
|
+
/**
|
|
24659
|
+
* Run revision reflected by this page.
|
|
24660
|
+
*/
|
|
24661
|
+
revision: number;
|
|
24662
|
+
}
|
|
24663
|
+
/**
|
|
24664
|
+
* Parameters for resuming a workflow run from its persisted identity.
|
|
24665
|
+
*
|
|
24666
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24667
|
+
* via the `definition` "WorkflowResumeRequest".
|
|
24668
|
+
*/
|
|
24669
|
+
/** @experimental */
|
|
24670
|
+
export interface WorkflowResumeRequest {
|
|
24671
|
+
/**
|
|
24672
|
+
* Workflow run identifier.
|
|
24673
|
+
*/
|
|
24674
|
+
runId: string;
|
|
24675
|
+
limits?: WorkflowRunLimits;
|
|
24676
|
+
/**
|
|
24677
|
+
* Whether to notify the originating session when the workflow completes.
|
|
24678
|
+
*/
|
|
24679
|
+
notifyOnComplete?: boolean;
|
|
24680
|
+
/**
|
|
24681
|
+
* Whether to emit workflow phase names to the session transcript.
|
|
24682
|
+
*/
|
|
24683
|
+
logPhaseNames?: boolean;
|
|
24684
|
+
}
|
|
24685
|
+
/**
|
|
24686
|
+
* Wire-only per-invocation workflow resource ceiling overrides.
|
|
24687
|
+
*
|
|
24688
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24689
|
+
* via the `definition` "WorkflowRunLimits".
|
|
24690
|
+
*/
|
|
24691
|
+
/** @experimental */
|
|
24692
|
+
export interface WorkflowRunLimits {
|
|
24693
|
+
/**
|
|
24694
|
+
* Maximum number of workflow subagents that may run concurrently.
|
|
24695
|
+
*/
|
|
24696
|
+
maxConcurrentSubagents?: number | null;
|
|
24697
|
+
/**
|
|
24698
|
+
* Maximum total number of workflow subagents that may be admitted.
|
|
24699
|
+
*/
|
|
24700
|
+
maxTotalSubagents?: number | null;
|
|
24701
|
+
/**
|
|
24702
|
+
* 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.
|
|
24703
|
+
*/
|
|
24704
|
+
timeoutSeconds?: number | null;
|
|
24705
|
+
/**
|
|
24706
|
+
* 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.
|
|
24707
|
+
*/
|
|
24708
|
+
maxAiCredits?: number | null;
|
|
24709
|
+
}
|
|
24710
|
+
/**
|
|
24711
|
+
* Resolved persisted workflow identity and resumed run envelope.
|
|
24712
|
+
*
|
|
24713
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24714
|
+
* via the `definition` "WorkflowResumeResult".
|
|
24715
|
+
*/
|
|
24716
|
+
/** @experimental */
|
|
24717
|
+
export interface WorkflowResumeResult {
|
|
24718
|
+
/**
|
|
24719
|
+
* Persisted workflow name resolved for the resumed run.
|
|
24720
|
+
*/
|
|
24721
|
+
workflowName: string;
|
|
24722
|
+
run: WorkflowRunResult;
|
|
24723
|
+
}
|
|
24724
|
+
/**
|
|
24725
|
+
* Complete current or terminal workflow run envelope.
|
|
24726
|
+
*
|
|
24727
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24728
|
+
* via the `definition` "WorkflowRunResult".
|
|
24729
|
+
*/
|
|
24730
|
+
/** @experimental */
|
|
24731
|
+
export interface WorkflowRunResult {
|
|
24732
|
+
/**
|
|
24733
|
+
* Workflow run identifier.
|
|
24734
|
+
*/
|
|
24735
|
+
runId: string;
|
|
24736
|
+
/**
|
|
24737
|
+
* One-based execution attempt represented by this envelope. Absent before the first attempt starts or when returned by an older runtime.
|
|
24738
|
+
*/
|
|
24739
|
+
attempt?: number;
|
|
24740
|
+
status: WorkflowRunStatus;
|
|
24741
|
+
/**
|
|
24742
|
+
* Completed workflow result.
|
|
24743
|
+
*/
|
|
24744
|
+
result?: JsonValue;
|
|
24745
|
+
/**
|
|
24746
|
+
* Error message for an errored run.
|
|
24747
|
+
*/
|
|
24748
|
+
error?: string;
|
|
24749
|
+
failure?: WorkflowRunFailure;
|
|
24750
|
+
/**
|
|
24751
|
+
* Reason for a halted or cancelled run.
|
|
24752
|
+
*/
|
|
24753
|
+
reason?: string;
|
|
24754
|
+
/**
|
|
24755
|
+
* Partial journal and progress snapshot for a halted, cancelled, or errored run.
|
|
24756
|
+
*/
|
|
24757
|
+
snapshot?: JsonValue;
|
|
24758
|
+
pauseInfo?: WorkflowPauseInfo;
|
|
24759
|
+
}
|
|
24760
|
+
/**
|
|
24761
|
+
* Full workflow run observability detail.
|
|
24762
|
+
*
|
|
24763
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24764
|
+
* via the `definition` "WorkflowRunDetail".
|
|
24765
|
+
*/
|
|
24766
|
+
/** @experimental */
|
|
24767
|
+
export interface WorkflowRunDetail {
|
|
24768
|
+
/**
|
|
24769
|
+
* Workflow run identifier.
|
|
24770
|
+
*/
|
|
24771
|
+
runId: string;
|
|
24772
|
+
/**
|
|
24773
|
+
* Registered workflow name.
|
|
24774
|
+
*/
|
|
24775
|
+
workflowName: string;
|
|
24776
|
+
/**
|
|
24777
|
+
* Human-readable workflow description.
|
|
24778
|
+
*/
|
|
24779
|
+
description: string;
|
|
24780
|
+
status: WorkflowRunStatus;
|
|
24781
|
+
/**
|
|
24782
|
+
* Monotonic durable run revision.
|
|
24783
|
+
*/
|
|
24784
|
+
revision: number;
|
|
24785
|
+
/**
|
|
24786
|
+
* Epoch milliseconds when the run was created.
|
|
24787
|
+
*/
|
|
24788
|
+
createdAt: number;
|
|
24789
|
+
/**
|
|
24790
|
+
* Epoch milliseconds when execution first started, or null before start.
|
|
24791
|
+
*/
|
|
24792
|
+
startedAt: number | null;
|
|
24793
|
+
/**
|
|
24794
|
+
* Epoch milliseconds when the durable run was last updated.
|
|
24795
|
+
*/
|
|
24796
|
+
updatedAt: number;
|
|
24797
|
+
/**
|
|
24798
|
+
* Epoch milliseconds when the run completed, or null while nonterminal.
|
|
24799
|
+
*/
|
|
24800
|
+
completedAt: number | null;
|
|
24801
|
+
/**
|
|
24802
|
+
* Current phase identity, or null before any phase is entered.
|
|
24803
|
+
*/
|
|
24804
|
+
currentPhase: WorkflowCurrentPhase | null;
|
|
24805
|
+
/**
|
|
24806
|
+
* Number of phases declared by the workflow.
|
|
24807
|
+
*/
|
|
24808
|
+
declaredPhaseCount: number;
|
|
24809
|
+
/**
|
|
24810
|
+
* Number of direct workflow agents currently live.
|
|
24811
|
+
*/
|
|
24812
|
+
liveAgentCount: number;
|
|
24813
|
+
/**
|
|
24814
|
+
* Total direct workflow agents spawned across all attempts.
|
|
24815
|
+
*/
|
|
24816
|
+
totalSpawnedAgentCount: number;
|
|
24817
|
+
consumed: WorkflowRunConsumed;
|
|
24818
|
+
declaredLimits: WorkflowDeclaredLimits;
|
|
24819
|
+
/**
|
|
24820
|
+
* Approved effective resource ceilings, or null until approved.
|
|
24821
|
+
*/
|
|
24822
|
+
approved: WorkflowDeclaredLimits | null;
|
|
24823
|
+
/**
|
|
24824
|
+
* Epoch milliseconds when this live-overlay snapshot was observed.
|
|
24825
|
+
*/
|
|
24826
|
+
observedAt: number;
|
|
24827
|
+
/**
|
|
24828
|
+
* Epoch milliseconds when the current active segment started, or null while inactive.
|
|
24829
|
+
*/
|
|
24830
|
+
activeSegmentStartedAt: number | null;
|
|
24831
|
+
/**
|
|
24832
|
+
* Terminal run outcome, or null while nonterminal.
|
|
24833
|
+
*/
|
|
24834
|
+
terminal: WorkflowRunTerminal | null;
|
|
24835
|
+
/**
|
|
24836
|
+
* Whether the durable run state currently passes runtime resume eligibility checks.
|
|
24837
|
+
*/
|
|
24838
|
+
canResume: boolean;
|
|
24839
|
+
/**
|
|
24840
|
+
* Lifecycle and timing observations for each workflow phase.
|
|
24841
|
+
*/
|
|
24842
|
+
phases: WorkflowPhaseObservation[];
|
|
24843
|
+
/**
|
|
24844
|
+
* Durable identities and live statuses for direct workflow agents.
|
|
24845
|
+
*/
|
|
24846
|
+
agents: WorkflowAgentSummary[];
|
|
24847
|
+
progress: WorkflowProgressPage;
|
|
24848
|
+
}
|
|
24849
|
+
/**
|
|
24850
|
+
* Options controlling workflow invocation.
|
|
24851
|
+
*
|
|
24852
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24853
|
+
* via the `definition` "WorkflowRunOptions".
|
|
24854
|
+
*/
|
|
24855
|
+
/** @experimental */
|
|
24856
|
+
export interface WorkflowRunOptions {
|
|
24857
|
+
limits?: WorkflowRunLimits;
|
|
24858
|
+
/**
|
|
24859
|
+
* Whether to notify the originating session when the workflow completes.
|
|
24860
|
+
*/
|
|
24861
|
+
notifyOnComplete?: boolean;
|
|
24862
|
+
/**
|
|
24863
|
+
* Whether to emit workflow phase names to the session transcript.
|
|
24864
|
+
*/
|
|
24865
|
+
logPhaseNames?: boolean;
|
|
24866
|
+
/**
|
|
24867
|
+
* Run identifier whose journal and progress should seed this resumed run.
|
|
24868
|
+
*/
|
|
24869
|
+
resumeFromRunId?: string;
|
|
24870
|
+
}
|
|
24871
|
+
/**
|
|
24872
|
+
* Parameters for invoking a registered workflow.
|
|
24873
|
+
*
|
|
24874
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24875
|
+
* via the `definition` "WorkflowRunRequest".
|
|
24876
|
+
*/
|
|
24877
|
+
/** @experimental */
|
|
24878
|
+
export interface WorkflowRunRequest {
|
|
24879
|
+
/**
|
|
24880
|
+
* Registered workflow name.
|
|
24881
|
+
*/
|
|
24882
|
+
name: string;
|
|
24883
|
+
/**
|
|
24884
|
+
* Workflow input value.
|
|
24885
|
+
*/
|
|
24886
|
+
args: JsonValue;
|
|
24887
|
+
options?: WorkflowRunOptions;
|
|
24888
|
+
}
|
|
24889
|
+
/**
|
|
24890
|
+
* A single changed file and its unified diff.
|
|
24891
|
+
*
|
|
24892
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24893
|
+
* via the `definition` "WorkspaceDiffFileChange".
|
|
24894
|
+
*/
|
|
24895
|
+
/** @experimental */
|
|
24896
|
+
export interface WorkspaceDiffFileChange {
|
|
24897
|
+
/**
|
|
24898
|
+
* Path to the changed file, relative to the workspace root when the file lives under it. A file changed outside the workspace root keeps a `../`-relative path, or an absolute path when no relative path exists (for example a different Windows drive).
|
|
24899
|
+
*/
|
|
24900
|
+
path: string;
|
|
24901
|
+
/**
|
|
24902
|
+
* Unified diff content for the file. Empty when the diff was truncated.
|
|
24903
|
+
*/
|
|
24904
|
+
diff: string;
|
|
24905
|
+
changeType: WorkspaceDiffFileChangeType;
|
|
24906
|
+
/**
|
|
24907
|
+
* Original file path for renamed files.
|
|
24908
|
+
*/
|
|
24909
|
+
oldPath?: string;
|
|
24910
|
+
/**
|
|
24911
|
+
* Whether the diff content was omitted because it exceeded the per-file size limit.
|
|
24912
|
+
*/
|
|
24913
|
+
isTruncated?: boolean;
|
|
24914
|
+
}
|
|
24915
|
+
/**
|
|
24916
|
+
* Workspace diff result for the requested mode.
|
|
24917
|
+
*
|
|
24918
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24919
|
+
* via the `definition` "WorkspaceDiffResult".
|
|
24920
|
+
*/
|
|
24921
|
+
/** @experimental */
|
|
24922
|
+
export interface WorkspaceDiffResult {
|
|
24923
|
+
requestedMode: WorkspaceDiffMode;
|
|
24924
|
+
mode: WorkspaceDiffMode;
|
|
24925
|
+
/**
|
|
24926
|
+
* Changed files and their unified diffs.
|
|
24927
|
+
*/
|
|
24928
|
+
changes: WorkspaceDiffFileChange[];
|
|
24929
|
+
/**
|
|
24930
|
+
* Default branch used for a branch diff, when branch mode was requested.
|
|
24931
|
+
*/
|
|
24932
|
+
baseBranch?: string;
|
|
24933
|
+
/**
|
|
24934
|
+
* Whether the requested diff fell back to unstaged changes, either because branch diff failed or session diff was unavailable.
|
|
24935
|
+
*/
|
|
24936
|
+
isFallback: boolean;
|
|
24937
|
+
unavailableReason?: HistoryRewindUnavailableReason;
|
|
24938
|
+
}
|
|
24939
|
+
/**
|
|
24940
|
+
* Compaction summary checkpoint to persist.
|
|
24941
|
+
*
|
|
24942
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24943
|
+
* via the `definition` "WorkspacesAddSummaryRequest".
|
|
24944
|
+
*/
|
|
24945
|
+
/** @experimental */
|
|
24946
|
+
export interface WorkspacesAddSummaryRequest {
|
|
24947
|
+
/**
|
|
24948
|
+
* Summary title shown in checkpoint listings.
|
|
24949
|
+
*/
|
|
24950
|
+
title: string;
|
|
24951
|
+
/**
|
|
24952
|
+
* Markdown summary content to persist.
|
|
24953
|
+
*/
|
|
24954
|
+
content: string;
|
|
24955
|
+
}
|
|
24956
|
+
/**
|
|
24957
|
+
* Persisted summary metadata and refreshed workspace metadata.
|
|
24958
|
+
*
|
|
24959
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24960
|
+
* via the `definition` "WorkspacesAddSummaryResult".
|
|
24961
|
+
*/
|
|
24962
|
+
/** @experimental */
|
|
24963
|
+
export interface WorkspacesAddSummaryResult {
|
|
24964
|
+
/**
|
|
24965
|
+
* Metadata for the persisted summary.
|
|
24966
|
+
*/
|
|
24967
|
+
summary?: {};
|
|
24968
|
+
/**
|
|
24969
|
+
* Refreshed metadata for the containing workspace.
|
|
24970
|
+
*/
|
|
24971
|
+
workspace?: {};
|
|
24972
|
+
[k: string]: unknown | undefined;
|
|
24973
|
+
}
|
|
24974
|
+
/**
|
|
24975
|
+
* Whether the autopilot objective file exists.
|
|
24976
|
+
*
|
|
24977
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24978
|
+
* via the `definition` "WorkspacesAutopilotObjectiveExistsResult".
|
|
24979
|
+
*/
|
|
24980
|
+
/** @experimental */
|
|
24981
|
+
export interface WorkspacesAutopilotObjectiveExistsResult {
|
|
24982
|
+
/**
|
|
24983
|
+
* True when the objective file exists.
|
|
24984
|
+
*/
|
|
24985
|
+
exists: boolean;
|
|
24986
|
+
}
|
|
24987
|
+
/**
|
|
24988
|
+
* Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename.
|
|
24989
|
+
*
|
|
24990
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
24991
|
+
* via the `definition` "WorkspacesCheckpoints".
|
|
24992
|
+
*/
|
|
24993
|
+
/** @experimental */
|
|
24994
|
+
export interface WorkspacesCheckpoints {
|
|
24995
|
+
/**
|
|
24996
|
+
* Checkpoint number assigned by the workspace manager
|
|
24997
|
+
*/
|
|
24998
|
+
number: number;
|
|
24999
|
+
/**
|
|
25000
|
+
* Human-readable checkpoint title
|
|
25001
|
+
*/
|
|
25002
|
+
title: string;
|
|
25003
|
+
/**
|
|
25004
|
+
* Filename of the checkpoint within the workspace checkpoints directory
|
|
25005
|
+
*/
|
|
25006
|
+
filename: string;
|
|
25007
|
+
}
|
|
25008
|
+
/**
|
|
25009
|
+
* Directory to create within the session workspace files directory.
|
|
25010
|
+
*
|
|
25011
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25012
|
+
* via the `definition` "WorkspacesCreateDirectoryRequest".
|
|
25013
|
+
*/
|
|
25014
|
+
/** @experimental */
|
|
25015
|
+
export interface WorkspacesCreateDirectoryRequest {
|
|
25016
|
+
/**
|
|
25017
|
+
* Slash-separated relative path within the workspace files directory
|
|
25018
|
+
*/
|
|
25019
|
+
path: string;
|
|
25020
|
+
/**
|
|
25021
|
+
* Whether to create missing parent directories. Defaults to false.
|
|
25022
|
+
*/
|
|
25023
|
+
recursive?: boolean;
|
|
25024
|
+
}
|
|
25025
|
+
/**
|
|
25026
|
+
* Relative path and UTF-8 content for the workspace file to create or overwrite.
|
|
25027
|
+
*
|
|
25028
|
+
* This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
|
|
25029
|
+
* via the `definition` "WorkspacesCreateFileRequest".
|
|
25030
|
+
*/
|
|
25031
|
+
/** @experimental */
|
|
25032
|
+
export interface WorkspacesCreateFileRequest {
|
|
25033
|
+
/**
|
|
25034
|
+
* Slash-separated relative path within the workspace files directory
|
|
25035
|
+
*/
|
|
25036
|
+
path: string;
|
|
25037
|
+
/**
|
|
25038
|
+
* File content to write as a UTF-8 string
|
|
23283
25039
|
*/
|
|
23284
25040
|
content: string;
|
|
23285
25041
|
}
|
|
@@ -23677,6 +25433,10 @@ export interface SessionFactoryPauseAtCheckpointResult {
|
|
|
23677
25433
|
action: FactoryPauseCheckpointAction;
|
|
23678
25434
|
}
|
|
23679
25435
|
/** @experimental */
|
|
25436
|
+
export interface SessionWorkflowPauseAtCheckpointResult {
|
|
25437
|
+
action: WorkflowPauseCheckpointAction;
|
|
25438
|
+
}
|
|
25439
|
+
/** @experimental */
|
|
23680
25440
|
export interface SessionModelListRequest {
|
|
23681
25441
|
/**
|
|
23682
25442
|
* If true, bypasses the per-session model list cache and re-fetches from CAPI.
|
|
@@ -23705,6 +25465,13 @@ export interface SessionMcpAppsCallToolResult {
|
|
|
23705
25465
|
[k: string]: JsonValue | undefined;
|
|
23706
25466
|
}
|
|
23707
25467
|
/** @experimental */
|
|
25468
|
+
export interface SessionPluginsMarketplacesRefreshRequest {
|
|
25469
|
+
/**
|
|
25470
|
+
* Marketplace name to refresh. When omitted, every registered marketplace is refreshed.
|
|
25471
|
+
*/
|
|
25472
|
+
name?: string;
|
|
25473
|
+
}
|
|
25474
|
+
/** @experimental */
|
|
23708
25475
|
export interface SessionPluginsReloadRequest {
|
|
23709
25476
|
/**
|
|
23710
25477
|
* Reload MCP server connections after refreshing plugins. Defaults to true.
|
|
@@ -24000,6 +25767,14 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
24000
25767
|
* @returns Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success.
|
|
24001
25768
|
*/
|
|
24002
25769
|
search: (params: CatalogSearchRequest) => Promise<CatalogSearchResult>;
|
|
25770
|
+
/**
|
|
25771
|
+
* 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.
|
|
25772
|
+
*
|
|
25773
|
+
* @param params Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.
|
|
25774
|
+
*
|
|
25775
|
+
* @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.
|
|
25776
|
+
*/
|
|
25777
|
+
select: (params: CatalogSelectionRequest) => Promise<CatalogSelectionResult>;
|
|
24003
25778
|
};
|
|
24004
25779
|
/** @experimental */
|
|
24005
25780
|
plugins: {
|
|
@@ -24230,7 +26005,7 @@ export declare function createServerRpc(connection: MessageConnection): {
|
|
|
24230
26005
|
/**
|
|
24231
26006
|
* Registers an SDK client as the session filesystem provider.
|
|
24232
26007
|
*
|
|
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.
|
|
26008
|
+
* @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
26009
|
*
|
|
24235
26010
|
* @returns Indicates whether the calling client was registered as the session filesystem provider.
|
|
24236
26011
|
*/
|
|
@@ -24724,6 +26499,108 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
24724
26499
|
};
|
|
24725
26500
|
};
|
|
24726
26501
|
/** @experimental */
|
|
26502
|
+
workflow: {
|
|
26503
|
+
/**
|
|
26504
|
+
* Runs a registered dynamic workflow by name at the top level.
|
|
26505
|
+
*
|
|
26506
|
+
* @param params Parameters for invoking a registered workflow.
|
|
26507
|
+
*
|
|
26508
|
+
* @returns Complete current or terminal workflow run envelope.
|
|
26509
|
+
*/
|
|
26510
|
+
run: (params: WorkflowRunRequest) => Promise<WorkflowRunResult>;
|
|
26511
|
+
/**
|
|
26512
|
+
* Resumes a dynamic workflow run using its persisted name, arguments, journal, and accounting.
|
|
26513
|
+
*
|
|
26514
|
+
* @param params Parameters for resuming a workflow run from its persisted identity.
|
|
26515
|
+
*
|
|
26516
|
+
* @returns Resolved persisted workflow identity and resumed run envelope.
|
|
26517
|
+
*/
|
|
26518
|
+
resume: (params: WorkflowResumeRequest) => Promise<WorkflowResumeResult>;
|
|
26519
|
+
/**
|
|
26520
|
+
* Gets the current or settled envelope for a dynamic workflow run.
|
|
26521
|
+
*
|
|
26522
|
+
* @param params Parameters for retrieving a workflow run.
|
|
26523
|
+
*
|
|
26524
|
+
* @returns Complete current or terminal workflow run envelope.
|
|
26525
|
+
*/
|
|
26526
|
+
getRun: (params: WorkflowGetRunRequest) => Promise<WorkflowRunResult>;
|
|
26527
|
+
/**
|
|
26528
|
+
* Lists durable dynamic workflow runs for this session in creation order.
|
|
26529
|
+
*
|
|
26530
|
+
* @param params Parameters for paging workflow runs.
|
|
26531
|
+
*
|
|
26532
|
+
* @returns A page of workflow runs in durable creation order.
|
|
26533
|
+
*/
|
|
26534
|
+
listRuns: (params: WorkflowListRunsRequest) => Promise<WorkflowListRunsResult>;
|
|
26535
|
+
/**
|
|
26536
|
+
* Gets durable and live observability detail for one dynamic workflow run.
|
|
26537
|
+
*
|
|
26538
|
+
* @param params Parameters for retrieving a workflow run.
|
|
26539
|
+
*
|
|
26540
|
+
* @returns Full workflow run observability detail.
|
|
26541
|
+
*/
|
|
26542
|
+
getRunDetail: (params: WorkflowGetRunRequest) => Promise<WorkflowRunDetail>;
|
|
26543
|
+
/**
|
|
26544
|
+
* Pages durable progress for one dynamic workflow run.
|
|
26545
|
+
*
|
|
26546
|
+
* @param params Parameters for paging workflow progress.
|
|
26547
|
+
*
|
|
26548
|
+
* @returns A bidirectional page of workflow progress.
|
|
26549
|
+
*/
|
|
26550
|
+
getRunProgress: (params: WorkflowGetRunProgressRequest) => Promise<WorkflowProgressPage>;
|
|
26551
|
+
/**
|
|
26552
|
+
* Requests cancellation of a dynamic workflow run and returns its run envelope.
|
|
26553
|
+
*
|
|
26554
|
+
* @param params Parameters for cancelling a workflow run.
|
|
26555
|
+
*
|
|
26556
|
+
* @returns Complete current or terminal workflow run envelope.
|
|
26557
|
+
*/
|
|
26558
|
+
cancel: (params: WorkflowCancelRequest) => Promise<WorkflowRunResult>;
|
|
26559
|
+
/**
|
|
26560
|
+
* Pauses a running dynamic workflow and returns its settled run envelope.
|
|
26561
|
+
*
|
|
26562
|
+
* @param params Parameters for pausing a running workflow.
|
|
26563
|
+
*
|
|
26564
|
+
* @returns Complete current or terminal workflow run envelope.
|
|
26565
|
+
*/
|
|
26566
|
+
pause: (params: WorkflowPauseRequest) => Promise<WorkflowRunResult>;
|
|
26567
|
+
/**
|
|
26568
|
+
* Records a batch of ordered dynamic workflow progress lines.
|
|
26569
|
+
*
|
|
26570
|
+
* @param params Parameters for recording workflow progress.
|
|
26571
|
+
*
|
|
26572
|
+
* @returns Acknowledgement that a workflow request was accepted.
|
|
26573
|
+
*/
|
|
26574
|
+
log: (params: WorkflowLogRequest) => Promise<WorkflowAckResult>;
|
|
26575
|
+
/**
|
|
26576
|
+
* Runs one dynamic-workflow-scoped subagent and returns its result.
|
|
26577
|
+
*
|
|
26578
|
+
* @param params Parameters for one workflow-scoped subagent call.
|
|
26579
|
+
*
|
|
26580
|
+
* @returns Result of one workflow-scoped subagent call.
|
|
26581
|
+
*/
|
|
26582
|
+
agent: (params: WorkflowAgentRequest) => Promise<WorkflowAgentResult>;
|
|
26583
|
+
/** @experimental */
|
|
26584
|
+
journal: {
|
|
26585
|
+
/**
|
|
26586
|
+
* Reads a memoized dynamic workflow journal entry.
|
|
26587
|
+
*
|
|
26588
|
+
* @param params Parameters for reading a workflow journal entry.
|
|
26589
|
+
*
|
|
26590
|
+
* @returns Result of reading a workflow journal entry.
|
|
26591
|
+
*/
|
|
26592
|
+
get: (params: WorkflowJournalGetRequest) => Promise<WorkflowJournalGetResult>;
|
|
26593
|
+
/**
|
|
26594
|
+
* Stores a memoized dynamic workflow journal entry.
|
|
26595
|
+
*
|
|
26596
|
+
* @param params Parameters for storing a workflow journal entry.
|
|
26597
|
+
*
|
|
26598
|
+
* @returns Acknowledgement that a workflow request was accepted.
|
|
26599
|
+
*/
|
|
26600
|
+
put: (params: WorkflowJournalPutRequest) => Promise<WorkflowAckResult>;
|
|
26601
|
+
};
|
|
26602
|
+
};
|
|
26603
|
+
/** @experimental */
|
|
24727
26604
|
model: {
|
|
24728
26605
|
/**
|
|
24729
26606
|
* 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 +27306,97 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
25429
27306
|
};
|
|
25430
27307
|
};
|
|
25431
27308
|
/** @experimental */
|
|
27309
|
+
managedSettings: {
|
|
27310
|
+
/**
|
|
27311
|
+
* 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.
|
|
27312
|
+
*
|
|
27313
|
+
* @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.
|
|
27314
|
+
*/
|
|
27315
|
+
get: () => Promise<ManagedSettingsResolvedData>;
|
|
27316
|
+
};
|
|
27317
|
+
/** @experimental */
|
|
25432
27318
|
plugins: {
|
|
25433
27319
|
/**
|
|
25434
|
-
* Lists
|
|
27320
|
+
* 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
27321
|
*
|
|
25436
27322
|
* @returns Plugins installed for the session, with their enabled state and version metadata.
|
|
25437
27323
|
*/
|
|
25438
27324
|
list: () => Promise<PluginList>;
|
|
27325
|
+
/**
|
|
27326
|
+
* Installs a plugin using the live session's authoritative account, working directory, and retained managed policy.
|
|
27327
|
+
*
|
|
27328
|
+
* @param params Plugin source resolved relative to the session's authoritative working directory.
|
|
27329
|
+
*
|
|
27330
|
+
* @returns Result of installing a plugin.
|
|
27331
|
+
*/
|
|
27332
|
+
install: (params: SessionPluginsInstallRequest) => Promise<PluginInstallResult>;
|
|
27333
|
+
/**
|
|
27334
|
+
* Uninstalls a plugin when permitted by the live session's retained managed policy.
|
|
27335
|
+
*
|
|
27336
|
+
* @param params Name (or spec) of the plugin to uninstall.
|
|
27337
|
+
*/
|
|
27338
|
+
uninstall: (params: PluginsUninstallRequest) => Promise<void>;
|
|
27339
|
+
/**
|
|
27340
|
+
* Updates an installed plugin using the live session's authoritative account, working directory, and retained managed policy.
|
|
27341
|
+
*
|
|
27342
|
+
* @param params Name (or spec) of the plugin to update.
|
|
27343
|
+
*
|
|
27344
|
+
* @returns Result of updating a single plugin.
|
|
27345
|
+
*/
|
|
27346
|
+
update: (params: PluginsUpdateRequest) => Promise<PluginUpdateResult>;
|
|
27347
|
+
/**
|
|
27348
|
+
* Enables installed plugins when permitted by the live session's retained managed policy.
|
|
27349
|
+
*
|
|
27350
|
+
* @param params Plugin names (or specs) to enable in the session's authoritative working directory.
|
|
27351
|
+
*/
|
|
27352
|
+
enable: (params: SessionPluginsEnableRequest) => Promise<void>;
|
|
27353
|
+
/**
|
|
27354
|
+
* Disables installed plugins when permitted by the live session's retained managed policy.
|
|
27355
|
+
*
|
|
27356
|
+
* @param params Plugin names (or specs) to disable in the session's authoritative working directory.
|
|
27357
|
+
*/
|
|
27358
|
+
disable: (params: SessionPluginsDisableRequest) => Promise<void>;
|
|
27359
|
+
/** @experimental */
|
|
27360
|
+
marketplaces: {
|
|
27361
|
+
/**
|
|
27362
|
+
* Lists registered and enterprise-managed desired marketplaces using the live session's retained policy.
|
|
27363
|
+
*
|
|
27364
|
+
* @returns All registered marketplaces, including built-in defaults.
|
|
27365
|
+
*/
|
|
27366
|
+
list: () => Promise<MarketplaceListResult>;
|
|
27367
|
+
/**
|
|
27368
|
+
* Adds a marketplace when permitted by the live session's retained managed policy.
|
|
27369
|
+
*
|
|
27370
|
+
* @param params Marketplace source and optional working directory for relative-path resolution.
|
|
27371
|
+
*
|
|
27372
|
+
* @returns Result of registering a new marketplace.
|
|
27373
|
+
*/
|
|
27374
|
+
add: (params: PluginsMarketplacesAddRequest) => Promise<MarketplaceAddResult>;
|
|
27375
|
+
/**
|
|
27376
|
+
* Removes a marketplace when permitted by the live session's retained managed policy.
|
|
27377
|
+
*
|
|
27378
|
+
* @param params Name of the marketplace to remove and an optional force flag.
|
|
27379
|
+
*
|
|
27380
|
+
* @returns Outcome of the remove attempt, including dependent-plugin info when applicable.
|
|
27381
|
+
*/
|
|
27382
|
+
remove: (params: PluginsMarketplacesRemoveRequest) => Promise<MarketplaceRemoveResult>;
|
|
27383
|
+
/**
|
|
27384
|
+
* Browses a marketplace resolved through the live session's working directory and retained managed policy.
|
|
27385
|
+
*
|
|
27386
|
+
* @param params Name of the marketplace whose plugin catalog to fetch.
|
|
27387
|
+
*
|
|
27388
|
+
* @returns Plugins advertised by the marketplace.
|
|
27389
|
+
*/
|
|
27390
|
+
browse: (params: PluginsMarketplacesBrowseRequest) => Promise<MarketplaceBrowseResult>;
|
|
27391
|
+
/**
|
|
27392
|
+
* Refreshes marketplaces resolved through the live session's working directory and retained managed policy.
|
|
27393
|
+
*
|
|
27394
|
+
* @param params Optional marketplace name; omit to refresh all.
|
|
27395
|
+
*
|
|
27396
|
+
* @returns Result of refreshing one or more marketplace catalogs.
|
|
27397
|
+
*/
|
|
27398
|
+
refresh: (params?: SessionPluginsMarketplacesRefreshRequest) => Promise<MarketplaceRefreshResult>;
|
|
27399
|
+
};
|
|
25439
27400
|
/**
|
|
25440
27401
|
* 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
27402
|
*
|
|
@@ -26144,6 +28105,22 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
|
|
|
26144
28105
|
* @returns Result of editing a queued message.
|
|
26145
28106
|
*/
|
|
26146
28107
|
updateText: (params: QueueUpdateTextRequest) => Promise<QueueUpdateTextResult>;
|
|
28108
|
+
/**
|
|
28109
|
+
* 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.
|
|
28110
|
+
*
|
|
28111
|
+
* @param params Conditional withdrawal of a single user message, before the runtime claims it for delivery.
|
|
28112
|
+
*
|
|
28113
|
+
* @returns Result of removing a queued item.
|
|
28114
|
+
*/
|
|
28115
|
+
withdrawMessage: (params: QueueWithdrawMessageRequest) => Promise<QueueRemoveAtResult>;
|
|
28116
|
+
/**
|
|
28117
|
+
* Atomically appends text and attachments to an unchanged, unconsumed local steering message. Returns updated=false if delivery or withdrawal already claimed the message.
|
|
28118
|
+
*
|
|
28119
|
+
* @param params Append to one pending steering message without changing its identity or delivery position.
|
|
28120
|
+
*
|
|
28121
|
+
* @returns Result of editing a queued message.
|
|
28122
|
+
*/
|
|
28123
|
+
appendSteering: (params: QueueAppendSteeringRequest) => Promise<QueueUpdateTextResult>;
|
|
26147
28124
|
/**
|
|
26148
28125
|
* Duplicates an addressable queued item immediately after its source.
|
|
26149
28126
|
*
|
|
@@ -26320,6 +28297,26 @@ export interface FactoryHandler {
|
|
|
26320
28297
|
*/
|
|
26321
28298
|
abort(params: FactoryAbortRequest): Promise<FactoryAckResult>;
|
|
26322
28299
|
}
|
|
28300
|
+
/** Handler for `workflow` client session API methods. */
|
|
28301
|
+
/** @experimental */
|
|
28302
|
+
export interface WorkflowHandler {
|
|
28303
|
+
/**
|
|
28304
|
+
* Asks the owning extension connection to execute a registered dynamic workflow.
|
|
28305
|
+
*
|
|
28306
|
+
* @param params Parameters sent to the owning extension to execute a workflow closure.
|
|
28307
|
+
*
|
|
28308
|
+
* @returns Result returned by an extension workflow closure.
|
|
28309
|
+
*/
|
|
28310
|
+
execute(params: WorkflowExecuteRequest): Promise<WorkflowExecuteResult>;
|
|
28311
|
+
/**
|
|
28312
|
+
* Asks the owning extension connection to abort a running dynamic workflow cooperatively.
|
|
28313
|
+
*
|
|
28314
|
+
* @param params Parameters for cooperatively aborting a workflow body.
|
|
28315
|
+
*
|
|
28316
|
+
* @returns Acknowledgement that a workflow request was accepted.
|
|
28317
|
+
*/
|
|
28318
|
+
abort(params: WorkflowAbortRequest): Promise<WorkflowAckResult>;
|
|
28319
|
+
}
|
|
26323
28320
|
/** Handler for `tasks` client session API methods. */
|
|
26324
28321
|
/** @experimental */
|
|
26325
28322
|
export interface TasksHandler {
|
|
@@ -26470,6 +28467,7 @@ export interface CanvasHandler {
|
|
|
26470
28467
|
export interface ClientSessionApiHandlers {
|
|
26471
28468
|
providerToken?: ProviderTokenHandler;
|
|
26472
28469
|
factory?: FactoryHandler;
|
|
28470
|
+
workflow?: WorkflowHandler;
|
|
26473
28471
|
tasks?: TasksHandler;
|
|
26474
28472
|
sessionFs?: SessionFsHandler;
|
|
26475
28473
|
canvas?: CanvasHandler;
|