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; the
13/// SDK pin test checks it against the committed manifest.
14pub const GENERATED_FINGERPRINT: &str =
15    "sha256:c94c3d1f2f51e6424074b9ec43eac3eedcf532d3dcd77351ec1383a87d3049c6";
16
17pub(crate) mod capability;
18pub(crate) mod command;
19pub(crate) mod envelope;
20pub(crate) mod error;
21pub(crate) mod handshake;
22pub(crate) mod method;
23pub(crate) mod request;
24pub(crate) mod view;
25
26pub use self::capability::CapabilityName;
27
28pub use self::command::{
29    CommandAcceptedResult, CommandAckStatus, SubagentInputParams, SubagentOwnerReasonParams,
30    SubagentTargetParams,
31};
32
33pub use self::envelope::{
34    ErrorResponse, JsonRpcVersion, Notification, Request, RequestId, SuccessResponse, TraceContext,
35};
36
37pub use self::error::{
38    AdmissionResolutionSummary, ApprovalRequirementRef, ApprovalResolutionSummary, ErrorData,
39    ErrorObject, UserInputSettlementSummary,
40};
41
42pub use self::error::kind::ErrorKind;
43
44pub use self::handshake::{
45    ClientCapabilities, ClientInfo, InitializeParams, InitializeResult, PlatformFamily, PlatformOs,
46    SandboxAvailability, SandboxUnavailableReason, SchemaInfo, ServerInfo, SessionDurability,
47};
48
49pub use self::method::approval::{
50    ApprovalDecideParams, ApprovalDecideResult, ApprovalListPendingParams,
51    ApprovalListPendingResult, ApprovalModeApplyOutcome, SessionSetApprovalModeParams,
52    SessionSetApprovalModeResult,
53};
54
55pub use self::method::computer_use::{
56    ComputerUseBlockedApp, ComputerUseChoice, ComputerUseSettings, ComputerUseSettingsReadParams,
57    ComputerUseSettingsUpdateParams,
58};
59
60pub use self::method::computer_use::apps::{
61    ComputerUseApp, ComputerUseAppChoice, ComputerUseAppLock, ComputerUseAppPatch,
62    ComputerUseInstalledApp,
63};
64
65pub use self::method::computer_use_setup::{
66    ComputerUsePermission, ComputerUseSetupChanged, ComputerUseSetupPhase,
67    ComputerUseSetupReadParams, ComputerUseSetupStartParams, ComputerUseSetupState,
68};
69
70pub use self::method::feedback::{
71    FeedbackClassification, FeedbackSubmitOutcome, FeedbackSubmitParams, FeedbackSubmitResult,
72};
73
74pub use self::method::goal::{
75    GoalClearParams, GoalCommandResult, GoalEditParams, GoalPauseParams, GoalResumeParams,
76    GoalSetParams,
77};
78
79pub use self::method::hook::{
80    HookCatalogEntry, HookEventName, HookHandlerKind, HookListParams, HookListResult,
81};
82
83pub use self::method::lifecycle::{
84    ForkCutPoint, QueuedInput, SessionForkParams, SessionForkResult, SessionReadParams,
85    SessionReadResult, SessionSideChatParams, SessionSideChatResult, SessionStartParams,
86    SessionStartResult,
87};
88
89pub use self::method::lifecycle::recovery::{
90    RecoveryEffectiveSource, RecoveryMode, RecoveryObservation, RecoveryObservedMode,
91    RecoveryQualification,
92};
93
94pub use self::method::lifecycle::runtime_worktree::{
95    RuntimeWorktree, RuntimeWorktreeCleanupPolicy, RuntimeWorktreeCleanupState,
96    RuntimeWorktreeOwnership,
97};
98
99pub use self::method::lifecycle::session_leave::{
100    SessionLeaveCompletedParams, SessionLeaveFailureReason, SessionLeaveOutcome,
101    SessionLeaveParams, SessionLeaveResult,
102};
103
104pub use self::method::lifecycle::session_list::{
105    SessionListBranchFilter, SessionListFilter, SessionListParams, SessionListResult,
106    SessionListSessionIdFilter, SessionListTextField, SessionListTextFilter,
107};
108
109pub use self::method::lifecycle::session_mcp::{
110    SessionConfig, SessionMcpServerConfig, SessionMcpServerMode, SessionMcpStdioFraming,
111};
112
113pub use self::method::lifecycle::session_resume::{
114    AbnormalEnd, BlockedPrompt, CheckpointBoundary, HistoryMode, HistoryNoneReason,
115    HistoryPreference, LastTurn, PendingRequestKind, PendingRequestPointer, SessionHistory,
116    SessionResumeParams, SessionResumeResult,
117};
118
119pub use self::method::limits::{
120    LimitsAboveMaxAxis, LimitsAxisValue, LimitsNetworkMode, SessionLimits, SessionLimitsChoice,
121};
122
123pub use self::method::media::{MediaUploadParams, MediaUploadResult};
124
125pub use self::method::plugin::{
126    PluginCatalogEntry, PluginChangedParams, PluginInstallLocalPathTarget,
127    PluginInstallMarketplaceTarget, PluginInstallParams, PluginInstallResult, PluginInstallScope,
128    PluginInstallTarget, PluginListParams, PluginListResult, PluginMarketplaceAddParams,
129    PluginMarketplaceChange, PluginMarketplaceChangedParams, PluginMarketplaceRecordResult,
130    PluginMarketplaceRemoveParams, PluginMarketplaceRemoveResult, PluginMarketplaceSkippedEntry,
131    PluginMarketplaceSourceShape, PluginMarketplaceUpdateParams, PluginSource,
132};
133
134pub use self::method::recap::{
135    RecapCancelParams, RecapCancelResult, RecapCompletedParams, RecapFailureReason, RecapOutcome,
136    RecapRequestParams, RecapRequestResult,
137};
138
139pub use self::method::runtime::{
140    CompactStatus, ModelSelection, SessionCompactParams, SessionCompactResult, SessionRenameParams,
141    SessionRenameResult, SessionSetModelParams, SessionSetModelResult,
142    SessionSetReasoningEffortParams, SessionSetReasoningEffortResult, SessionUserShellParams,
143    SessionUserShellResult,
144};
145
146pub use self::method::runtime::model_catalog::{
147    ModelCatalogEntry, ModelCatalogSource, ModelCost, ModelDescribedReasoningEffort,
148    ModelListParams, ModelListResult, ModelReasoningEffortVariants,
149    UnknownModelReasoningEffortVariants,
150};
151
152pub use self::method::session::{RunningElsewhere, RunningElsewhereOrigin, Session, SessionKind};
153
154pub use self::method::session_events::{
155    SessionClosedParams, SessionClosedReason, SessionStartedParams, SessionStatus,
156    SessionStatusChangedParams,
157};
158
159pub use self::method::session_satellites::{
160    AttentionFlag, EffectiveApprovalModeState, EffectivePermissionState, ForkProvenance,
161    SessionListChangedParams, SessionSpawnedBy, SideProvenance,
162};
163
164pub use self::method::skill::{
165    SkillActivationScope, SkillActivationState, SkillCatalogEntry, SkillChangedParams,
166    SkillImportCounts, SkillImportFailure, SkillImportParams, SkillImportQuarantine,
167    SkillImportResult, SkillImportSource, SkillInvocationSource, SkillListParams, SkillListResult,
168    SkillSetActivationParams, SkillSetActivationResult, SkillSource,
169};
170
171pub use self::method::snapshot::{
172    BranchState, EffectiveModel, PendingApprovalPointer, PendingUserInputPointer,
173    ReasoningEffortState, SnapshotAnchor, SnapshotState, TodoListState, TurnRef, ViewSnapshot,
174};
175
176pub use self::method::task::{
177    TaskBackgroundParams, TaskCommandResult, TaskExecutionMode, TaskListEntry, TaskListParams,
178    TaskListResult, TaskListStatus, TaskStopAllParams, TaskStopAllResult, TaskStopParams,
179};
180
181pub use self::method::turn::{
182    CommandStatus, IfBusy, ReasoningEffort, TurnCancelParams, TurnCancelResult, TurnInputPart,
183    TurnInputPartType, TurnInterruptParams, TurnInterruptResult, TurnStartDisposition,
184    TurnStartParams, TurnStartResult, TurnSteerParams, TurnSteerResult, TurnUnqueueParams,
185    TurnUnqueueResult, TurnUserShell,
186};
187
188pub use self::method::usage::{
189    SubscriptionUsage, SubscriptionUsageWeekly, SubscriptionUsageWindow, UsageReadResult,
190};
191
192pub use self::method::user_input::{
193    UserInputAnswerParams, UserInputAnswerResult, UserInputCancelParams, UserInputCancelResult,
194    UserInputClarifyParams, UserInputClarifyResult, UserInputEngagedParams,
195    UserInputInterruptParams, UserInputInterruptResult,
196};
197
198pub use self::method::view::{
199    ItemReadOutputEncoding, ItemReadOutputParams, ItemReadOutputResult, UnframedViewNotification,
200    UnframedViewNotificationParams, ViewPageAnchor, ViewPageDirection, ViewPageParams,
201    ViewPageResolvedAnchor, ViewPageResult, ViewSubscribeParams, ViewSubscribeResult,
202    ViewUnsubscribeParams, ViewUnsubscribeResult,
203};
204
205pub use self::method::workflow::{
206    WorkflowCancelParams, WorkflowChildAction, WorkflowChildControlParams, WorkflowControlResult,
207    WorkflowPauseParams, WorkflowResumeParams, WorkflowResumeResult,
208};
209
210pub use self::method::worktree::{SessionWorktree, WorktreeOrigin, WorktreeStartRequest};
211
212pub use self::request::RequestReceipt;
213
214pub use self::view::{RecordPosition, SourceRange, StreamRef};
215
216pub use self::view::approval::{
217    ApprovalOrigin, ApprovalRequestParams, ApprovalResolvedParams, ApprovalStage,
218    ApprovalStageResolution, ApprovalSubagentOrigin, ApprovalSubject, ApprovalSuggestedPrefix,
219    ApprovalUpdatedParams,
220};
221
222pub use self::view::approval::decision::{
223    ApprovalAmendment, ApprovalAmendmentDurability, ApprovalChange, ApprovalChoice,
224    ApprovalChoiceScope, ApprovalDecision, ApprovalPersistenceStatus, ApprovalPolicyResult,
225    ApprovalResolvedBy, ApprovalStageEvidence,
226};
227
228pub use self::view::approval_card_facts::{
229    ApprovalCuaCardFacts, ApprovalCuaDataFact, ApprovalCuaMask, ApprovalCuaPage, ApprovalCuaPoint,
230    ApprovalCuaStep,
231};
232
233pub use self::view::event::{
234    ItemCompletedParams, ItemDeltaParams, ItemStartedParams, ItemUpdatedParams, LimitKind,
235    QuotaDetail, RetractOutcome, TurnCompletedParams, TurnError, TurnErrorKind,
236    TurnForegroundCompletedParams, TurnModelRetryScheduledParams, TurnRetractedParams,
237    TurnRetryScheduledParams, TurnStartedParams, TurnTerminal, TurnUnqueuedParams,
238};
239
240pub use self::view::gap::ViewGapParams;
241
242pub use self::view::health::{SessionViewHealth, SessionViewHealthChangedParams};
243
244pub use self::view::item::object::item::Item;
245
246pub use self::view::item::object::replay_hint::ReplayHint;
247
248pub use self::view::item::object::scheduled_fire::ScheduledFireMembers;
249
250pub use self::view::item::object::tool_call::ToolCallMembers;
251
252pub use self::view::item_background::{BackgroundInitiator, BackgroundState, BackgroundStatus};
253
254pub use self::view::item_background_terminal_completion::BackgroundTerminalCompletion;
255
256pub use self::view::item_content::{
257    CompactionOutcome, CompactionTrigger, HookRunStatus, ItemKind, ItemStatus, MessageAttachment,
258    ModelVisibleContent, OutputRef, OutputRefAvailability, PatchSummary, SubagentControlStatus,
259    SubagentResult, WebSearchHit, WorkflowChild, WorkflowTokenBudget,
260};
261
262pub use self::view::item_damaged_range::DamagedRange;
263
264pub use self::view::item_earlier_history::{EarlierHistory, EarlierHistoryMessage};
265
266pub use self::view::item_hold::HeldFor;
267
268pub use self::view::item_status::{
269    StatusAttempt, StatusChildren, StatusHealth, StatusHealthLevel, StatusProgress, StatusStep,
270};
271
272pub use self::view::message_phase::MessagePhase;
273
274pub use self::view::monitor_inbox::{
275    MonitorInboxItemAdmittedParams, MonitorInboxItemDrainedParams, MonitorInboxItemVoidedParams,
276};
277
278pub use self::view::state::{
279    ApprovalMode, ApprovalModeSource, Goal, ModelChangeSource, ReasoningEffortChangeSource,
280    SessionApprovalModeChangedParams, SessionBranchChangedParams, SessionGoalChangedParams,
281    SessionModelChangedParams, SessionModelRouteUnservedParams,
282    SessionReasoningEffortChangedParams, SessionTodoListChangedParams, TodoItem, TodoStatus, Vcs,
283};
284
285pub use self::view::state::permission_profile::{
286    PermissionApprovalAxis, PermissionAxes, PermissionFilesystemAxis, PermissionNetworkAxis,
287    ReviewerAuthority,
288};
289
290pub use self::view::state::session_name::{SessionNameChangedParams, SessionNameOrigin};
291
292pub use self::view::state::usage::{
293    ContextPressureLevel, ContextUsage, CumulativeCost, CumulativeTokenUsage,
294    SessionContextUsageParams, SessionTokenUsageParams, TokenUsage,
295};
296
297pub use self::view::tool_label::ToolDisplayLabel;
298
299pub use self::view::tool_receipt::{CronReceipt, CronReceiptJob, ToolReceipt, ToolReceiptBody};
300
301pub use self::view::tool_receipt::code_mode::{
302    CodeModeLanguage, CodeModeOutputSpan, CodeModeOutputStream, CodeModeReceipt,
303};
304
305pub use self::view::tool_receipt::vocabulary::{ToolReceiptOperation, ToolReceiptOutcome};
306
307pub use self::view::user_input::{
308    UserInputAnswer, UserInputClarification, UserInputOption, UserInputOptionPreview,
309    UserInputOutcome, UserInputQuestion, UserInputRequestParams, UserInputSelection,
310    UserInputSelectionMode, UserInputSettledParams,
311};