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