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