Skip to main content

muse_code_sdk/
msp.rs

1// @generated from the MSP stable schema and protocol sources; do not edit by hand.
2
3//! Stable Muse Session Protocol (MSP) wire types.
4//!
5//! Serde names equal the stable schema names; use these types and never
6//! rename an MSP field or variant by hand.
7
8// Copied doc comments can name schema-only helpers or private items the
9// copy omits; those links render as plain text.
10#![allow(rustdoc::broken_intra_doc_links, rustdoc::private_intra_doc_links)]
11
12/// Fingerprint of the stable schema these types were generated from, derived
13/// from its bytes at build time; the byte-equality gate keeps the committed
14/// copy honest.
15pub const GENERATED_FINGERPRINT: &str =
16    include_str!(concat!(env!("OUT_DIR"), "/msp-stable-fingerprint.txt"));
17
18pub(crate) mod capability;
19pub(crate) mod command;
20pub(crate) mod envelope;
21pub(crate) mod error;
22pub(crate) mod handshake;
23pub(crate) mod method;
24pub(crate) mod request;
25pub(crate) mod view;
26
27pub use self::capability::CapabilityName;
28
29pub use self::command::{
30    CommandAcceptedResult, CommandAckStatus, SubagentInputParams, SubagentOwnerReasonParams,
31    SubagentTargetParams,
32};
33
34pub use self::envelope::{
35    ErrorResponse, JsonRpcVersion, Notification, Request, RequestId, SuccessResponse, TraceContext,
36};
37
38pub use self::error::{
39    AdmissionResolutionSummary, ApprovalRequirementRef, ApprovalResolutionSummary, ErrorObject,
40    UserInputSettlementSummary,
41};
42
43pub use self::error::data::ErrorData;
44
45pub use self::error::kind::ErrorKind;
46
47pub use self::handshake::{
48    ClientCapabilities, ClientInfo, InitializeParams, InitializeResult, LaunchContext,
49    PlatformFamily, PlatformOs, SandboxAvailability, SandboxUnavailableReason, SchemaInfo,
50    ServerInfo, SessionDurability,
51};
52
53pub use self::method::approval::{
54    ApprovalDecideParams, ApprovalDecideResult, ApprovalListPendingParams,
55    ApprovalListPendingResult, ApprovalModeApplyOutcome, ClientApprovalRule,
56    ClientApprovalRuleState, PolicyRuleOrigin, SessionSetApprovalModeParams,
57    SessionSetApprovalModeResult,
58};
59
60pub use self::method::computer_use::{
61    ComputerUseBlockedApp, ComputerUseChoice, ComputerUseSettings, ComputerUseSettingsReadParams,
62    ComputerUseSettingsUpdateParams,
63};
64
65pub use self::method::computer_use::apps::{
66    ComputerUseApp, ComputerUseAppChoice, ComputerUseAppLock, ComputerUseAppPatch,
67    ComputerUseInstalledApp,
68};
69
70pub use self::method::computer_use_setup::{
71    ComputerUsePermission, ComputerUseSetupChanged, ComputerUseSetupPhase,
72    ComputerUseSetupReadParams, ComputerUseSetupStartParams, ComputerUseSetupState,
73};
74
75pub use self::method::feedback::{
76    FeedbackClassification, FeedbackSubmitOutcome, FeedbackSubmitParams, FeedbackSubmitResult,
77};
78
79pub use self::method::goal::{
80    GoalClearParams, GoalCommandResult, GoalEditParams, GoalPauseParams, GoalResumeParams,
81    GoalSetParams,
82};
83
84pub use self::method::hook::{
85    HookCatalogEntry, HookEventName, HookHandlerKind, HookListParams, HookListResult,
86};
87
88pub use self::method::lifecycle::{
89    ForkCutPoint, SessionForkParams, SessionForkResult, SessionSideChatParams,
90    SessionSideChatResult,
91};
92
93pub use self::method::lifecycle::recovery::{
94    RecoveryEffectiveSource, RecoveryMode, RecoveryObservation, RecoveryObservedMode,
95    RecoveryQualification,
96};
97
98pub use self::method::lifecycle::runtime_worktree::{
99    RuntimeWorktree, RuntimeWorktreeCleanupPolicy, RuntimeWorktreeCleanupReason,
100    RuntimeWorktreeCleanupState, RuntimeWorktreeOwnership,
101};
102
103pub use self::method::lifecycle::session_config_mt::{
104    SessionEndpointTransportAuthMode, SessionModelEndpointTransportOverride,
105    SessionSettingsOverrideValue, SessionSettingsOverrides,
106};
107
108pub use self::method::lifecycle::session_config_mt_providers::{
109    SessionEndpointProviderOverride, SessionEndpointProviders,
110};
111
112pub use self::method::lifecycle::session_leave::{
113    SessionLeaveCompletedParams, SessionLeaveFailureReason, SessionLeaveOutcome,
114    SessionLeaveParams, SessionLeaveResult,
115};
116
117pub use self::method::lifecycle::session_list::{
118    SessionListBranchFilter, SessionListFilter, SessionListParams, SessionListResult,
119    SessionListSessionIdFilter, SessionListTextField, SessionListTextFilter,
120};
121
122pub use self::method::lifecycle::session_mcp::SessionConfig;
123
124pub use self::method::lifecycle::session_mcp_server::{
125    SessionMcpServerConfig, SessionMcpServerMode, SessionMcpStdioFraming,
126};
127
128pub use self::method::lifecycle::session_read::{
129    DeliveredInput, PrunedSubagent, QueuedInput, SessionReadParams, SessionReadResult,
130};
131
132pub use self::method::lifecycle::session_resume::{
133    ContinuePausedSource, SessionResumeParams, SessionResumeResult,
134};
135
136pub use self::method::lifecycle::session_resume::attachments::RestartReceipt;
137
138pub use self::method::lifecycle::session_resume::history::{
139    CheckpointBoundary, HistoryMode, HistoryNoneReason, HistoryPreference, SessionHistory,
140};
141
142pub use self::method::lifecycle::session_resume_input_assets::{
143    ClientRef, MissingInputAssets, UnavailableInputAsset, UnavailableInputAssetReason,
144};
145
146pub use self::method::lifecycle::session_resume_members::{
147    AbnormalEnd, AutoRecovery, AutoRecoveryOutcome, AutoRecoveryReason, BlockedPrompt,
148    CronQuarantine, LastTurn, MissingPredecessor, ModelIdRefusal, PendingRequestKind,
149    PendingRequestPointer,
150};
151
152pub use self::method::lifecycle::session_start::{
153    SessionLoadWarning, SessionLoadWarningItem, SessionStartParams, SessionStartResult,
154};
155
156pub use self::method::lifecycle::session_start_nodes::{
157    SessionStartNode, SessionStartNodeRoster, SessionStartRosterNode,
158};
159
160pub use self::method::lifecycle::session_start_switch_policy::SwitchPolicy;
161
162pub use self::method::limits::{
163    LimitsAboveMaxAxis, LimitsAxisValue, LimitsNetworkMode, SessionLimits, SessionLimitsChoice,
164};
165
166pub use self::method::media::{MediaUploadParams, MediaUploadResult};
167
168pub use self::method::model_complete::{
169    ModelCancelParams, ModelCancelResult, ModelCompleteMessage, ModelCompleteParams,
170    ModelCompleteResult, ModelCompleteRole,
171};
172
173pub use self::method::model_completed::{
174    ModelCompleteOutcome, ModelCompleteStopReason, ModelCompleteUsage, ModelCompletedParams,
175};
176
177pub use self::method::plugin::{
178    PluginCatalogEntry, PluginChangedParams, PluginInstallLocalPathTarget,
179    PluginInstallMarketplaceTarget, PluginInstallParams, PluginInstallResult, PluginInstallScope,
180    PluginInstallTarget, PluginListParams, PluginListResult, PluginMarketplaceAddParams,
181    PluginMarketplaceChange, PluginMarketplaceChangedParams, PluginMarketplaceRecordResult,
182    PluginMarketplaceRemoveParams, PluginMarketplaceRemoveResult, PluginMarketplaceSkippedEntry,
183    PluginMarketplaceSourceShape, PluginMarketplaceUpdateParams, PluginSource,
184};
185
186pub use self::method::recap::{
187    RecapCancelParams, RecapCancelResult, RecapCompletedParams, RecapFailureReason, RecapOutcome,
188    RecapRequestParams, RecapRequestResult,
189};
190
191pub use self::method::runtime::{
192    CompactStatus, ModelSelection, SessionCompactParams, SessionCompactResult, SessionRenameParams,
193    SessionRenameResult, SessionSetModelParams, SessionSetModelResult,
194    SessionSetReasoningEffortParams, SessionSetReasoningEffortResult, SessionUserShellParams,
195    SessionUserShellResult,
196};
197
198pub use self::method::runtime::model_catalog::{
199    ModelCatalogEntry, ModelCatalogSource, ModelCost, ModelDescribedReasoningEffort,
200    ModelListParams, ModelListResult, ModelReasoningEffortVariants,
201    UnknownModelReasoningEffortVariants,
202};
203
204pub use self::method::session::{RunningElsewhere, RunningElsewhereOrigin, Session, SessionKind};
205
206pub use self::method::session::members::ProbeDegradedReason;
207
208pub use self::method::session_events::{
209    SessionClosedParams, SessionClosedReason, SessionStartedParams, SessionStatus,
210    SessionStatusChangedParams,
211};
212
213pub use self::method::session_external_wait::{
214    ExternalWaitView, SessionClearExternalWaitParams, SessionClearExternalWaitResult,
215    SessionDeclareExternalWaitParams, SessionDeclareExternalWaitResult,
216};
217
218pub use self::method::session_satellites::{
219    AttentionFlag, EffectiveApprovalModeState, EffectivePermissionState, ForkProvenance,
220    NeedsInputReason, SessionListChangedParams, SessionSpawnedBy, SideProvenance,
221};
222
223pub use self::method::skill::{
224    SkillActivationScope, SkillActivationState, SkillCatalogEntry, SkillChangedParams,
225    SkillImportCounts, SkillImportFailure, SkillImportParams, SkillImportQuarantine,
226    SkillImportResult, SkillImportSource, SkillInvocationSource, SkillListParams, SkillListResult,
227    SkillSetActivationParams, SkillSetActivationResult, SkillSource,
228};
229
230pub use self::method::snapshot::{
231    BranchState, EffectiveModel, PendingApprovalPointer, PendingUserInputPointer,
232    ReasoningEffortState, SnapshotAnchor, SnapshotState, TodoListState, TurnRef, ViewSnapshot,
233};
234
235pub use self::method::subagent::{SubagentListParams, SubagentListResult, SubagentRosterEntry};
236
237pub use self::method::task::{
238    TaskBackgroundParams, TaskCommandResult, TaskExecutionMode, TaskListEntry, TaskListParams,
239    TaskListResult, TaskListStatus, TaskStopAllParams, TaskStopAllResult, TaskStopParams,
240};
241
242pub use self::method::turn::{
243    CommandStatus, IfBusy, ReasoningEffort, TurnCancelParams, TurnCancelResult,
244    TurnInterruptParams, TurnInterruptResult, TurnStartDisposition, TurnStartParams,
245    TurnStartResult, TurnSteerParams, TurnSteerResult, TurnUnqueueParams, TurnUnqueueResult,
246    TurnUserShell,
247};
248
249pub use self::method::turn::input_part::{TurnInputPart, TurnInputPartType};
250
251pub use self::method::usage::{
252    SubscriptionUsage, SubscriptionUsageWeekly, SubscriptionUsageWindow, UsageReadResult,
253};
254
255pub use self::method::user_input::{
256    UserInputAnswerParams, UserInputAnswerResult, UserInputCancelParams, UserInputCancelResult,
257    UserInputClarifyParams, UserInputClarifyResult, UserInputEngagedParams,
258    UserInputInterruptParams, UserInputInterruptResult,
259};
260
261pub use self::method::view::{
262    ItemReadOutputEncoding, ItemReadOutputParams, ItemReadOutputResult, UnframedViewNotification,
263    UnframedViewNotificationParams, ViewPageAnchor, ViewPageDirection, ViewPageParams,
264    ViewPageResolvedAnchor, ViewPageResult, ViewSubscribeParams, ViewSubscribeResult,
265    ViewUnsubscribeParams, ViewUnsubscribeResult,
266};
267
268pub use self::method::workflow::{
269    WorkflowCancelParams, WorkflowChildAction, WorkflowChildControlParams, WorkflowControlResult,
270    WorkflowPauseParams, WorkflowResumeParams, WorkflowResumeResult,
271};
272
273pub use self::method::worktree::{SessionWorktree, WorktreeOrigin, WorktreeStartRequest};
274
275pub use self::request::RequestReceipt;
276
277pub use self::view::{RecordPosition, SourceRange, StreamRef};
278
279pub use self::view::approval::{
280    ApprovalOrigin, ApprovalRequestParams, ApprovalResolvedParams, ApprovalStage,
281    ApprovalStageResolution, ApprovalSubagentOrigin, ApprovalSubject, ApprovalSuggestedPrefix,
282    ApprovalUpdatedParams, ComputerUseLockHolder,
283};
284
285pub use self::view::approval::decision::{
286    ApprovalAmendment, ApprovalAmendmentDurability, ApprovalChange, ApprovalChoice,
287    ApprovalChoiceScope, ApprovalDecision, ApprovalPersistenceStatus, ApprovalPolicyResult,
288    ApprovalResolvedBy, ApprovalStageEvidence,
289};
290
291pub use self::view::approval_card_facts::{
292    ApprovalCuaCardFacts, ApprovalCuaDataFact, ApprovalCuaMask, ApprovalCuaPage, ApprovalCuaPoint,
293    ApprovalCuaStep,
294};
295
296pub use self::view::event::{
297    ItemCompletedParams, ItemDeltaParams, ItemStartedParams, ItemUpdatedParams, LimitKind,
298    QuotaDetail, RetractOutcome, TurnCompletedParams, TurnError, TurnErrorKind,
299    TurnForegroundCompletedParams, TurnModelAttemptStartedParams, TurnModelRetryScheduledParams,
300    TurnRetractedParams, TurnRetryScheduledParams, TurnStartedParams, TurnTerminal,
301    TurnUnqueuedParams,
302};
303
304pub use self::view::gap::ViewGapParams;
305
306pub use self::view::health::{SessionViewHealth, SessionViewHealthChangedParams};
307
308pub use self::view::item::object::body_completion::{
309    BodyCompletionCorrelation, BodyCompletionMembers,
310};
311
312pub use self::view::item::object::item::Item;
313
314pub use self::view::item::object::notice::{NoticeOrigin, NoticeSeverity, NoticeSubject};
315
316pub use self::view::item::object::replay_hint::ReplayHint;
317
318pub use self::view::item::object::scheduled_fire::ScheduledFireMembers;
319
320pub use self::view::item::object::subagent_members::SubagentMembers;
321
322pub use self::view::item::object::tool_call::{BackgroundTarget, ToolCallMembers};
323
324pub use self::view::item_background::{BackgroundInitiator, BackgroundState, BackgroundStatus};
325
326pub use self::view::item_background_terminal_completion::BackgroundTerminalCompletion;
327
328pub use self::view::item_content::{
329    CompactionOutcome, CompactionTrigger, MessageAttachment, ModelVisibleContent, OutputRef,
330    OutputRefAvailability, PatchSummary, WebSearchHit,
331};
332
333pub use self::view::item_damaged_range::DamagedRange;
334
335pub use self::view::item_earlier_history::{EarlierHistory, EarlierHistoryMessage};
336
337pub use self::view::item_hold::HeldFor;
338
339pub use self::view::item_kind::{HookRunStatus, ItemKind, ItemStatus};
340
341pub use self::view::item_peer_message::PeerMessage;
342
343pub use self::view::item_status::{
344    StatusAttempt, StatusChildren, StatusHealth, StatusHealthLevel, StatusProgress, StatusStep,
345};
346
347pub use self::view::item_subagent_workflow::{
348    SubagentControlStatus, SubagentResult, WorkflowChild, WorkflowTokenBudget, WorkspacePlacement,
349};
350
351pub use self::view::message_phase::MessagePhase;
352
353pub use self::view::monitor_inbox::{
354    MonitorInboxItemAdmittedParams, MonitorInboxItemDrainedParams, MonitorInboxItemVoidedParams,
355    MonitorInboxSnapshotEntry,
356};
357
358pub use self::view::state::{
359    ApprovalMode, ApprovalModeSource, Goal, ModelChangeSource, ReasoningEffortChangeSource,
360    SessionApprovalModeChangedParams, SessionBranchChangedParams, SessionGoalChangedParams,
361    SessionModelChangedParams, SessionModelRouteUnservedParams,
362    SessionReasoningEffortChangedParams, SessionTodoListChangedParams, TodoItem, TodoStatus, Vcs,
363};
364
365pub use self::view::state::permission_profile::{
366    PermissionApprovalAxis, PermissionAxes, PermissionFilesystemAxis, PermissionNetworkAxis,
367    ReviewerAuthority,
368};
369
370pub use self::view::state::session_name::{SessionNameChangedParams, SessionNameOrigin};
371
372pub use self::view::state::usage::{
373    ContextPressureLevel, ContextUsage, CumulativeCost, CumulativeTokenUsage,
374    SessionContextUsageParams, SessionTokenUsageParams, TokenUsage,
375};
376
377pub use self::view::subagent_input_phase::SubagentInputPhase;
378
379pub use self::view::subagent_result_status::SubagentResultStatus;
380
381pub use self::view::tool_label::ToolDisplayLabel;
382
383pub use self::view::tool_receipt::{CronReceipt, CronReceiptJob, ToolReceipt, ToolReceiptBody};
384
385pub use self::view::tool_receipt::code_mode::{
386    CodeModeLanguage, CodeModeOutputSpan, CodeModeOutputStream, CodeModeReceipt,
387};
388
389pub use self::view::tool_receipt::vocabulary::{ToolReceiptOperation, ToolReceiptOutcome};
390
391pub use self::view::user_input::{
392    UserInputAnswer, UserInputClarification, UserInputOption, UserInputOptionPreview,
393    UserInputOutcome, UserInputQuestion, UserInputRequestParams, UserInputSelection,
394    UserInputSelectionMode, UserInputSettledParams,
395};