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