Skip to content
Muse Code Developer Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Overview
Integrate with Muse Code
Quickstart
MSP concepts
MSP concepts
Sessions and turns
Commands and idempotency
Approvals
Resume
Exit classification
Durability profiles
The item-revision fold model
MSP wire protocol
MSP wire-level implementer's guide
Envelope and ids
Framing and caps
Backpressure
Errors
Conformance
Cookbook
About the cookbook
Stream a turn's answer into your UI
Approve or deny a tool call
Cancel a running turn
Resume a session and verify what came back
Survive the host dying under you
Handle a fingerprint mismatch
Classify every way the host can exit
List models and switch mid-session
Retry without double-submitting
Answer the agent's question
Queue, steer, and reclaim turns
Examples
Overview
The quickstart journey
The shared harness
Host operations
What keeps working
Protocol changelog
Extend Muse Code
Overview
Skills
Hooks
MCP servers
Plugins
Overview
Quickstart
Concepts
Packages and capabilities
Trust, review and scopes
Hooks in plugins
MCP servers in plugins
Marketplaces and updates
Compatibility with other plugin formats
Plugins in SDK sessions
Examples
Overview
The weather plugin
A guard hook that blocks risky tool calls
An MCP server in a plugin
Importing a Claude Code or Codex plugin
Reference
Overview
SDK reference
Overview
AbnormalExit
ApprovalDecisionInput
ApprovalFailure
ApprovalFailureHandler
ApprovalHandler
checkServedFingerprint
COMMAND_REJECTED_CODE
COMMAND_REJECTED_KIND
CommandErrorResponse
CommandOptions
Connection
ConnectionOptions
createUuidV7Mint
DeepReadonly
DeltaApplyOutcome
DiscardedSessions
DuplexTransport
ExitClassification
EXPECTED_SCHEMA_FINGERPRINT
fingerprintMismatchMessage
FingerprintWarning
FoldedItem
FoldItems
FoldOutcome
FoldSessionState
GapFillFailureHandler
GapFillFailureReason
HostDeathDischarge
HostDeathNotification
HostStartFailure
isLaunchFailure
ItemApplyOutcome
ItemStore
MspError
MspHandshake
MuseClient
MuseClientOptions
MuseClientSpawnOptions
MuseForeignSessionError
MuseGapFillError
MuseHostDiedError
MuseHostStartError
MuseServeChild
MuseServeChildOptions
MuseSessionDiscardedError
NotificationHandler
PendingApproval
PendingCommandAck
PendingCommandEntry
PendingCommandSet
PendingCommandSetOptions
PendingCommandView
PendingDisposition
PendingJoinPlan
PendingRetirement
PermissionProfileNotApplied
ProcessExit
ProtocolError
ProtocolErrorHandler
readSessionDurability
ReplayAnswer
ResumeSessionOptions
RevisionedItem
SendUserTurnOptions
ServerRequestHandler
Session
SessionApplyOutcome
SessionApplyRefusal
SessionDurabilityProfile
SessionFold
SessionFoldView
SessionGapBuffered
SessionGapOverlap
SessionOpening
SessionOptions
SessionStateMethod
SessionStateParams
SessionStateStore
SnapshotJoinFacts
SpawnedMspConnection
spawnMspConnection
SpawnMspConnectionOptions
StaleDroppableMethod
StartSessionOptions
StateApplyOutcome
StateValue
TerminalUnknownItemAnnotation
TransportEof
Turn
TurnEntry
TurnOutcome
TurnState
ViewEvent
Python SDK reference
Overview
ApprovalDecisionInput
ApprovalFailure
ApprovalFailureHandler
ApprovalHandler
DiscardedSessions
EXPECTED_SCHEMA_FINGERPRINT
GapFillFailureHandler
GapFillFailureReason
HostDeathDischarge
HostDeathNotification
is_abnormal_host_death
is_launch_failure
ItemStore
load_transcript
MuseClient
MuseClientOptions
MuseClientSpawnOptions
MuseForeignSessionError
MuseGapFillError
MuseHostDiedError
MuseHostStartError
MuseSessionDiscardedError
PendingCommandSet
PendingCommandView
PermissionProfileNotApplied
read_session_durability
replay_into_fold
ResumeSessionOptions
SendUserTurnOptions
Session
SessionApplyOutcome
SessionDurabilityProfile
SessionFold
SessionFoldView
SessionGapBuffered
SessionGapOverlap
SessionStateStore
StartSessionOptions
SyncMuseClient
SyncSession
SyncTurn
Transcript
transcript_dirs
TransportEof
Turn
TurnOutcome
Plugin reference
Manifest
Hook events and payloads
The muse plugins command
Validation diagnostics
Wire protocol reference
Methods
Overview
account/loginCancel
account/loginStart
account/logout
account/read
admission/decide
admission/listPending
approval/decide
approval/listPending
computerUseSettings/read
computerUseSettings/update
computerUseSetup/check
computerUseSetup/read
computerUseSetup/start
feedback/submit
goal/clear
goal/edit
goal/pause
goal/resume
goal/set
hook/list
initialize
item/readOutput
log/page
log/streams
log/subscribe
log/unsubscribe
mcpServer/list
mcpServer/oauthLogin
mcpServer/oauthLoginCancel
mcpServer/oauthLogout
media/upload
model/list
peer/list
permissionProfile/list
plugin/install
plugin/list
plugin/marketplaceAdd
plugin/marketplaceRemove
plugin/marketplaceUpdate
projection/list
projection/read
recap/cancel
recap/request
session/compact
session/fork
session/list
session/promptHint
session/read
session/rename
session/reportStartupPhases
session/resume
session/setApprovalMode
session/setModel
session/setPermissionProfile
session/setReasoningEffort
session/sideChat
session/start
session/userShell
settings/read
settings/readSchema
settings/writeMany
settings/writeValue
skill/import
skill/list
skill/setActivation
subagent/close
subagent/followupTask
subagent/interrupt
subagent/readResult
subagent/reopen
subagent/resume
subagent/sendMessage
subagent/stop
task/background
task/list
task/stop
task/stopAll
turn/cancel
turn/interrupt
turn/start
turn/steer
turn/unqueue
usage/read
userInput/answer
userInput/cancel
userInput/clarify
userInput/interrupt
view/page
view/subscribe
view/unsubscribe
workflow/cancel
workflow/childControl
workflow/pause
workflow/resume
worktree/list
Notifications
Overview
account/changed
account/loginCompleted
admission/requested
admission/resolved
approval/requested
approval/resolved
approval/reviewing
approval/updated
computerUseSetup/changed
initialized
item/completed
item/delta
item/started
item/updated
log/gap
log/record
mcpServer/oauthLoginCompleted
plugin/changed
plugin/marketplaceChanged
recap/completed
session/approvalModeChanged
session/branchChanged
session/closed
session/contextUsage
session/goalChanged
session/listChanged
session/modelChanged
session/modelRouteUnserved
session/nameChanged
session/permissionProfileChanged
session/reasoningEffortChanged
session/started
session/statusChanged
session/todoListChanged
session/tokenUsage
session/viewHealthChanged
skill/changed
turn/completed
turn/foregroundCompleted
turn/modelRetryScheduled
turn/retracted
turn/retryScheduled
turn/started
turn/unqueued
usage/changed
userInput/engaged
userInput/requested
userInput/settled
view/gap
Errors
Overview
admissionAlreadyResolved (-32071)
admissionChoiceInvalid (-32072)
admissionNotFound (-32070)
approvalAlreadyResolved (-32051)
approvalChoiceInvalid (-32052)
approvalNotFound (-32050)
approvalRequirementStale (-32053)
approvalReviewerUnavailable (-32054)
backpressured (-32031)
boundaryPruned (-32042)
cancelled (-32014)
capabilityRequired (-32010)
commandRejected (-32030)
computerUseUnavailable (-32033)
forkBoundaryInvalid (-32023)
inputTooLarge (-32002)
internal (-32603)
interrupted (-32013)
invalidParams (-32602)
invalidRequest (-32600)
marketplaceAlreadyExists (-32036)
marketplaceNotFound (-32034)
methodNotFound (-32601)
missingAnchor (-32060)
notFound (-32011)
outputUnavailable (-32041)
overloaded (-32001)
parseError (-32700)
pluginMutationsDisabled (-32037)
pluginNotFound (-32035)
prunedPrefix (-32061)
sessionAmbiguous (-32022)
sessionInUse (-32021)
sessionNotFound (-32020)
sessionNotLoaded (-32024)
sessionStreamMismatch (-32025)
skillNotFound (-32032)
unknownProjection (-32064)
unknownStream (-32063)
uploadNotFound (-32038)
userInputAlreadySettled (-32056)
userInputAnswerInvalid (-32057)
userInputNotFound (-32055)
viewTruncated (-32040)
workspaceNotTrusted (-32029)
wrongStream (-32062)
Types
Overview
AccountLoginCancelResult
AccountLoginCompletedParams
AccountLoginOutcome
AccountLoginStartParams
AccountLoginStartResult
AccountLoginType
AccountState
AccountStateKind
AdmissionChoice
AdmissionDecideParams
AdmissionDecideResult
AdmissionDecision
AdmissionListPendingParams
AdmissionListPendingResult
AdmissionRequestedViewParams
AdmissionRequestParams
AdmissionResolutionSummary
AdmissionResolvedViewParams
ApprovalAmendment
ApprovalAmendmentDurability
ApprovalChange
ApprovalChoice
ApprovalChoiceScope
ApprovalDecideParams
ApprovalDecideResult
ApprovalDecision
ApprovalListPendingParams
ApprovalListPendingResult
ApprovalMode
ApprovalModeApplyOutcome
ApprovalModeSource
ApprovalOrigin
ApprovalPersistenceStatus
ApprovalPolicyResult
ApprovalRequestParams
ApprovalRequirementRef
ApprovalResolutionSummary
ApprovalResolvedBy
ApprovalResolvedParams
ApprovalStage
ApprovalStageEvidence
ApprovalStageResolution
ApprovalSubagentOrigin
ApprovalSubject
ApprovalSuggestedPrefix
ApprovalUpdatedParams
AttentionFlag
BackgroundInitiator
BackgroundState
BackgroundStatus
BranchState
CapabilityName
ClientCapabilities
ClientInfo
CodeModeLanguage
CodeModeOutputSpan
CodeModeOutputStream
CodeModeReceipt
CommandAcceptedResult
CommandAckStatus
CommandStatus
CompactionOutcome
CompactionTrigger
CompactStatus
ComputerUseApp
ComputerUseAppChoice
ComputerUseAppLock
ComputerUseAppPatch
ComputerUseBlockedApp
ComputerUseChoice
ComputerUseInstalledApp
ComputerUsePermission
ComputerUseSettings
ComputerUseSettingsReadParams
ComputerUseSettingsUpdateParams
ComputerUseSetupChanged
ComputerUseSetupPhase
ComputerUseSetupReadParams
ComputerUseSetupStartParams
ComputerUseSetupState
ContextPressureLevel
ContextUsage
CronReceipt
CronReceiptJob
CumulativeCost
CumulativeTokenUsage
EffectiveApprovalModeState
EffectiveModel
EffectivePermissionState
ErrorData
ErrorKind
ErrorObject
ErrorResponse
FeedbackClassification
FeedbackSubmitOutcome
FeedbackSubmitParams
FeedbackSubmitResult
ForkCutPoint
ForkProvenance
Goal
GoalClearParams
GoalCommandResult
GoalEditParams
GoalPauseParams
GoalResumeParams
GoalSetParams
HistoryMode
HistoryNoneReason
HistoryPreference
HookCatalogEntry
HookEventName
HookHandlerKind
HookListParams
HookListResult
HookRunStatus
IfBusy
InitializeParams
InitializeResult
Item
ItemCompletedParams
ItemDeltaParams
ItemKind
ItemReadOutputEncoding
ItemReadOutputParams
ItemReadOutputResult
ItemStartedParams
ItemStatus
ItemUpdatedParams
JsonRpcVersion
LastTurn
LimitKind
LogGapParams
LogGapReason
LogPageParams
LogPageResult
LogRecordParams
LogStreamEntry
LogStreamsParams
LogStreamsResult
LogSubscribeParams
LogSubscribeResult
LogUnsubscribeParams
LogUnsubscribeResult
McpOAuthLoginOutcome
McpOAuthRevocation
McpServerListOAuth
McpServerListParams
McpServerListResult
McpServerListRow
McpServerListSource
McpServerListTransport
McpServerOAuthLoginCancelParams
McpServerOAuthLoginCancelResult
McpServerOAuthLoginCompletedParams
McpServerOAuthLoginParams
McpServerOAuthLoginResult
McpServerOAuthLogoutParams
McpServerOAuthLogoutResult
MediaUploadParams
MediaUploadResult
MessageAttachment
MessagePhase
ModelCatalogEntry
ModelCatalogSource
ModelChangeSource
ModelCost
ModelDescribedReasoningEffort
ModelListParams
ModelListResult
ModelReasoningEffortVariants
ModelSelection
ModelVisibleContent
Notification
OutputRef
OutputRefAvailability
PatchSummary
PeerListParams
PeerListResult
PeerRow
PeerStatus
PendingApprovalPointer
PendingRequestKind
PendingRequestPointer
PendingUserInputPointer
PermissionApprovalAxis
PermissionAxes
PermissionFilesystemAxis
PermissionNetworkAxis
PermissionProfileApplyOutcome
PermissionProfileListParams
PermissionProfileListResult
PermissionProfileRow
PermissionProfileSource
PermissionProfileUnavailableReason
PlatformFamily
PlatformOs
PluginCatalogEntry
PluginChangedParams
PluginInstallLocalPathTarget
PluginInstallMarketplaceTarget
PluginInstallParams
PluginInstallResult
PluginInstallScope
PluginInstallTarget
PluginListParams
PluginListResult
PluginMarketplaceAddParams
PluginMarketplaceChange
PluginMarketplaceChangedParams
PluginMarketplaceRecordResult
PluginMarketplaceRemoveParams
PluginMarketplaceRemoveResult
PluginMarketplaceSkippedEntry
PluginMarketplaceSourceShape
PluginMarketplaceUpdateParams
PluginSource
ProjectionBasis
ProjectionEntry
ProjectionListParams
ProjectionListResult
ProjectionReadParams
ProjectionReadResult
QuotaDetail
RawLogCursor
RawLogRecordEnvelope
ReasoningEffort
ReasoningEffortChangeSource
ReasoningEffortState
RecapCancelParams
RecapCancelResult
RecapCompletedParams
RecapFailureReason
RecapOutcome
RecapRequestParams
RecapRequestResult
RecordPosition
Request
RequestId
RequestReceipt
RetractOutcome
ReviewerAuthority
SandboxAvailability
SandboxUnavailableReason
SchemaInfo
ServerInfo
Session
SessionApprovalModeChangedParams
SessionBranchChangedParams
SessionClosedParams
SessionClosedReason
SessionCompactParams
SessionCompactResult
SessionConfig
SessionContextUsageParams
SessionDurability
SessionForkParams
SessionForkResult
SessionGoalChangedParams
SessionHistory
SessionKind
SessionListBranchFilter
SessionListChangedParams
SessionListFilter
SessionListParams
SessionListResult
SessionListSessionIdFilter
SessionListTextField
SessionListTextFilter
SessionMcpServerConfig
SessionMcpServerMode
SessionMcpStdioFraming
SessionModelChangedParams
SessionModelRouteUnservedParams
SessionNameChangedParams
SessionNameOrigin
SessionPermissionProfileChangedParams
SessionPromptHintCandidate
SessionPromptHintParams
SessionPromptHintResult
SessionReadParams
SessionReadResult
SessionReasoningEffortChangedParams
SessionRenameParams
SessionRenameResult
SessionReportStartupPhase
SessionReportStartupPhaseSpan
SessionReportStartupPhasesParams
SessionReportStartupPhasesResult
SessionReportTerminalColorProvenance
SessionResumeParams
SessionResumeResult
SessionSetApprovalModeParams
SessionSetApprovalModeResult
SessionSetModelParams
SessionSetModelResult
SessionSetPermissionProfileParams
SessionSetPermissionProfileResult
SessionSetReasoningEffortParams
SessionSetReasoningEffortResult
SessionSideChatParams
SessionSideChatResult
SessionStartedParams
SessionStartParams
SessionStartResult
SessionStatus
SessionStatusChangedParams
SessionTodoListChangedParams
SessionTokenUsageParams
SessionUserShellParams
SessionUserShellResult
SessionViewHealth
SessionViewHealthChangedParams
SessionWorktree
SettingsReadResult
SettingsReadSchemaResult
SettingsWriteEdit
SettingsWriteManyParams
SettingsWriteManyResult
SettingsWriteResultEntry
SettingsWriteValueParams
SettingsWriteValueResult
SideProvenance
SkillActivationScope
SkillActivationState
SkillCatalogEntry
SkillChangedParams
SkillImportCounts
SkillImportFailure
SkillImportParams
SkillImportQuarantine
SkillImportResult
SkillImportSource
SkillListParams
SkillListResult
SkillSetActivationParams
SkillSetActivationResult
SkillSource
SnapshotAnchor
SnapshotState
SourceRange
StatusAttempt
StatusChildren
StatusHealth
StatusHealthLevel
StatusProgress
StatusStep
StreamRef
SubagentControlStatus
SubagentInputParams
SubagentOwnerReasonParams
SubagentResult
SubagentTargetParams
SubscriptionUsage
SubscriptionUsageWeekly
SubscriptionUsageWindow
SuccessResponse
TaskBackgroundParams
TaskCommandResult
TaskListEntry
TaskListParams
TaskListResult
TaskListStatus
TaskStopAllParams
TaskStopAllResult
TaskStopParams
TodoItem
TodoListState
TodoStatus
TokenUsage
ToolDisplayLabel
ToolReceipt
ToolReceiptOperation
ToolReceiptOutcome
TraceContext
TurnCancelParams
TurnCancelResult
TurnCompletedParams
TurnError
TurnErrorKind
TurnForegroundCompletedParams
TurnInputPart
TurnInputPartType
TurnInterruptParams
TurnInterruptResult
TurnModelRetryScheduledParams
TurnRef
TurnRetractedParams
TurnRetryScheduledParams
TurnStartDisposition
TurnStartedParams
TurnStartParams
TurnStartResult
TurnSteerParams
TurnSteerResult
TurnTerminal
TurnUnqueuedParams
TurnUnqueueParams
TurnUnqueueResult
TurnUserShell
UnframedViewNotification
UnframedViewNotificationParams
UnknownModelReasoningEffortVariants
UsageReadResult
UserInputAnswer
UserInputAnswerParams
UserInputAnswerResult
UserInputCancelParams
UserInputCancelResult
UserInputClarification
UserInputClarifyParams
UserInputClarifyResult
UserInputEngagedParams
UserInputInterruptParams
UserInputInterruptResult
UserInputOption
UserInputOptionPreview
UserInputOutcome
UserInputQuestion
UserInputRequestParams
UserInputSelection
UserInputSelectionMode
UserInputSettledParams
UserInputSettlementSummary
Vcs
ViewGapParams
ViewPageAnchor
ViewPageDirection
ViewPageParams
ViewPageResolvedAnchor
ViewPageResult
ViewSnapshot
ViewSubscribeParams
ViewSubscribeResult
ViewUnsubscribeParams
ViewUnsubscribeResult
WebSearchHit
WorkflowCancelParams
WorkflowChild
WorkflowChildAction
WorkflowChildControlParams
WorkflowControlResult
WorkflowPauseParams
WorkflowResumeParams
WorkflowResumeResult
WorkflowTokenBudget
WorktreeListEntry
WorktreeListParams
WorktreeListResult
WorktreeOrigin
WorktreeStartRequest
Capabilities
Overview
computerUseHostSetup
computerUseSetup
feedback
peerMessaging
rawLog
sessionListStream
sessionMcp
sessionRename
userShell
Reserved identifiers
Overview
-32012
-32060..-32069
-32070..-32079
deprecationNotice
Select theme
Dark
Light
Auto
Reserved
-32012
-32060..-32069
-32070..-32079
deprecationNotice
Source
schema/msp/experimental/msp.schema.json