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:cfdb6d2525601b9bac76584ccb0610ab3a5539b5e4f51141f079b99b39fcb4e0";
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, SessionForkParams, SessionForkResult, SessionReadParams, SessionReadResult,
85    SessionSideChatParams, SessionSideChatResult, SessionStartParams, SessionStartResult,
86};
87
88pub use self::method::lifecycle::recovery::{
89    RecoveryEffectiveSource, RecoveryMode, RecoveryObservation, RecoveryObservedMode,
90    RecoveryQualification,
91};
92
93pub use self::method::lifecycle::session_leave::{
94    SessionLeaveCompletedParams, SessionLeaveFailureReason, SessionLeaveOutcome,
95    SessionLeaveParams, SessionLeaveResult,
96};
97
98pub use self::method::lifecycle::session_list::{
99    SessionListBranchFilter, SessionListFilter, SessionListParams, SessionListResult,
100    SessionListSessionIdFilter, SessionListTextField, SessionListTextFilter,
101};
102
103pub use self::method::lifecycle::session_mcp::{
104    SessionConfig, SessionMcpServerConfig, SessionMcpServerMode, SessionMcpStdioFraming,
105};
106
107pub use self::method::lifecycle::session_resume::{
108    BlockedPrompt, CheckpointBoundary, HistoryMode, HistoryNoneReason, HistoryPreference, LastTurn,
109    PendingRequestKind, PendingRequestPointer, SessionHistory, SessionResumeParams,
110    SessionResumeResult,
111};
112
113pub use self::method::limits::{
114    LimitsAboveMaxAxis, LimitsAxisValue, LimitsNetworkMode, SessionLimits, SessionLimitsChoice,
115};
116
117pub use self::method::media::{MediaUploadParams, MediaUploadResult};
118
119pub use self::method::plugin::{
120    PluginCatalogEntry, PluginChangedParams, PluginInstallLocalPathTarget,
121    PluginInstallMarketplaceTarget, PluginInstallParams, PluginInstallResult, PluginInstallScope,
122    PluginInstallTarget, PluginListParams, PluginListResult, PluginMarketplaceAddParams,
123    PluginMarketplaceChange, PluginMarketplaceChangedParams, PluginMarketplaceRecordResult,
124    PluginMarketplaceRemoveParams, PluginMarketplaceRemoveResult, PluginMarketplaceSkippedEntry,
125    PluginMarketplaceSourceShape, PluginMarketplaceUpdateParams, PluginSource,
126};
127
128pub use self::method::recap::{
129    RecapCancelParams, RecapCancelResult, RecapCompletedParams, RecapFailureReason, RecapOutcome,
130    RecapRequestParams, RecapRequestResult,
131};
132
133pub use self::method::runtime::{
134    CompactStatus, ModelSelection, SessionCompactParams, SessionCompactResult, SessionRenameParams,
135    SessionRenameResult, SessionSetModelParams, SessionSetModelResult,
136    SessionSetReasoningEffortParams, SessionSetReasoningEffortResult, SessionUserShellParams,
137    SessionUserShellResult,
138};
139
140pub use self::method::runtime::model_catalog::{
141    ModelCatalogEntry, ModelCatalogSource, ModelCost, ModelDescribedReasoningEffort,
142    ModelListParams, ModelListResult, ModelReasoningEffortVariants,
143    UnknownModelReasoningEffortVariants,
144};
145
146pub use self::method::session::{
147    AttentionFlag, EffectiveApprovalModeState, EffectivePermissionState, ForkProvenance, Session,
148    SessionKind, SessionListChangedParams, SideProvenance,
149};
150
151pub use self::method::session_events::{
152    SessionClosedParams, SessionClosedReason, SessionStartedParams, SessionStatus,
153    SessionStatusChangedParams,
154};
155
156pub use self::method::skill::{
157    SkillActivationScope, SkillActivationState, SkillCatalogEntry, SkillChangedParams,
158    SkillImportCounts, SkillImportFailure, SkillImportParams, SkillImportQuarantine,
159    SkillImportResult, SkillImportSource, SkillInvocationSource, SkillListParams, SkillListResult,
160    SkillSetActivationParams, SkillSetActivationResult, SkillSource,
161};
162
163pub use self::method::snapshot::{
164    BranchState, EffectiveModel, PendingApprovalPointer, PendingUserInputPointer,
165    ReasoningEffortState, SnapshotAnchor, SnapshotState, TodoListState, TurnRef, ViewSnapshot,
166};
167
168pub use self::method::task::{
169    TaskBackgroundParams, TaskCommandResult, TaskExecutionMode, TaskListEntry, TaskListParams,
170    TaskListResult, TaskListStatus, TaskStopAllParams, TaskStopAllResult, TaskStopParams,
171};
172
173pub use self::method::turn::{
174    CommandStatus, IfBusy, ReasoningEffort, TurnCancelParams, TurnCancelResult, TurnInputPart,
175    TurnInputPartType, TurnInterruptParams, TurnInterruptResult, TurnStartDisposition,
176    TurnStartParams, TurnStartResult, TurnSteerParams, TurnSteerResult, TurnUnqueueParams,
177    TurnUnqueueResult, TurnUserShell,
178};
179
180pub use self::method::usage::{
181    SubscriptionUsage, SubscriptionUsageWeekly, SubscriptionUsageWindow, UsageReadResult,
182};
183
184pub use self::method::user_input::{
185    UserInputAnswerParams, UserInputAnswerResult, UserInputCancelParams, UserInputCancelResult,
186    UserInputClarifyParams, UserInputClarifyResult, UserInputEngagedParams,
187    UserInputInterruptParams, UserInputInterruptResult,
188};
189
190pub use self::method::view::{
191    ItemReadOutputEncoding, ItemReadOutputParams, ItemReadOutputResult, UnframedViewNotification,
192    UnframedViewNotificationParams, ViewPageAnchor, ViewPageDirection, ViewPageParams,
193    ViewPageResolvedAnchor, ViewPageResult, ViewSubscribeParams, ViewSubscribeResult,
194    ViewUnsubscribeParams, ViewUnsubscribeResult,
195};
196
197pub use self::method::workflow::{
198    WorkflowCancelParams, WorkflowChildAction, WorkflowChildControlParams, WorkflowControlResult,
199    WorkflowPauseParams, WorkflowResumeParams, WorkflowResumeResult,
200};
201
202pub use self::method::worktree::{SessionWorktree, WorktreeOrigin, WorktreeStartRequest};
203
204pub use self::request::RequestReceipt;
205
206pub use self::view::{RecordPosition, SourceRange, StreamRef};
207
208pub use self::view::approval::{
209    ApprovalOrigin, ApprovalRequestParams, ApprovalResolvedParams, ApprovalStage,
210    ApprovalStageResolution, ApprovalSubagentOrigin, ApprovalSubject, ApprovalSuggestedPrefix,
211    ApprovalUpdatedParams,
212};
213
214pub use self::view::approval::decision::{
215    ApprovalAmendment, ApprovalAmendmentDurability, ApprovalChange, ApprovalChoice,
216    ApprovalChoiceScope, ApprovalDecision, ApprovalPersistenceStatus, ApprovalPolicyResult,
217    ApprovalResolvedBy, ApprovalStageEvidence,
218};
219
220pub use self::view::approval_card_facts::{
221    ApprovalCuaCardFacts, ApprovalCuaPage, ApprovalCuaPoint, ApprovalCuaStep,
222};
223
224pub use self::view::event::{
225    ItemCompletedParams, ItemDeltaParams, ItemStartedParams, ItemUpdatedParams, LimitKind,
226    QuotaDetail, RetractOutcome, TurnCompletedParams, TurnError, TurnErrorKind,
227    TurnForegroundCompletedParams, TurnModelRetryScheduledParams, TurnRetractedParams,
228    TurnRetryScheduledParams, TurnStartedParams, TurnTerminal, TurnUnqueuedParams,
229};
230
231pub use self::view::gap::ViewGapParams;
232
233pub use self::view::health::{SessionViewHealth, SessionViewHealthChangedParams};
234
235pub use self::view::item::object::Item;
236
237pub use self::view::item::object::scheduled_fire::ScheduledFireMembers;
238
239pub use self::view::item::object::tool_call::ToolCallMembers;
240
241pub use self::view::item_background::{BackgroundInitiator, BackgroundState, BackgroundStatus};
242
243pub use self::view::item_background_terminal_completion::BackgroundTerminalCompletion;
244
245pub use self::view::item_content::{
246    CompactionOutcome, CompactionTrigger, HookRunStatus, ItemKind, ItemStatus, MessageAttachment,
247    ModelVisibleContent, OutputRef, OutputRefAvailability, PatchSummary, SubagentControlStatus,
248    SubagentResult, WebSearchHit, WorkflowChild, WorkflowTokenBudget,
249};
250
251pub use self::view::item_damaged_range::DamagedRange;
252
253pub use self::view::item_status::{
254    StatusAttempt, StatusChildren, StatusHealth, StatusHealthLevel, StatusProgress, StatusStep,
255};
256
257pub use self::view::message_phase::MessagePhase;
258
259pub use self::view::monitor_inbox::{
260    MonitorInboxItemAdmittedParams, MonitorInboxItemDrainedParams, MonitorInboxItemVoidedParams,
261};
262
263pub use self::view::state::{
264    ApprovalMode, ApprovalModeSource, Goal, ModelChangeSource, ReasoningEffortChangeSource,
265    SessionApprovalModeChangedParams, SessionBranchChangedParams, SessionGoalChangedParams,
266    SessionModelChangedParams, SessionModelRouteUnservedParams,
267    SessionReasoningEffortChangedParams, SessionTodoListChangedParams, TodoItem, TodoStatus, Vcs,
268};
269
270pub use self::view::state::permission_profile::{
271    PermissionApprovalAxis, PermissionAxes, PermissionFilesystemAxis, PermissionNetworkAxis,
272    ReviewerAuthority,
273};
274
275pub use self::view::state::session_name::{SessionNameChangedParams, SessionNameOrigin};
276
277pub use self::view::state::usage::{
278    ContextPressureLevel, ContextUsage, CumulativeCost, CumulativeTokenUsage,
279    SessionContextUsageParams, SessionTokenUsageParams, TokenUsage,
280};
281
282pub use self::view::tool_label::ToolDisplayLabel;
283
284pub use self::view::tool_receipt::{CronReceipt, CronReceiptJob, ToolReceipt, ToolReceiptBody};
285
286pub use self::view::tool_receipt::code_mode::{
287    CodeModeLanguage, CodeModeOutputSpan, CodeModeOutputStream, CodeModeReceipt,
288};
289
290pub use self::view::tool_receipt::vocabulary::{ToolReceiptOperation, ToolReceiptOutcome};
291
292pub use self::view::user_input::{
293    UserInputAnswer, UserInputClarification, UserInputOption, UserInputOptionPreview,
294    UserInputOutcome, UserInputQuestion, UserInputRequestParams, UserInputSelection,
295    UserInputSelectionMode, UserInputSettledParams,
296};