Expand description
Meerkat contracts — canonical wire types, surface schemas, and error contracts.
This crate is the single source of truth for all wire-facing types. Surface crates (RPC, REST, MCP, CLI) consume these types directly.
Re-exports§
pub use capability::CapabilitiesResponse;pub use capability::CapabilityEntry;pub use error::CapabilityHint;pub use error::ErrorCategory;pub use error::ErrorCode;pub use error::WireError;pub use event_catalog::KNOWN_AGENT_EVENT_TYPES;pub use protocol::Protocol;pub use request_lifecycle::RequestLifecycle;pub use request_lifecycle::RpcRequestLifecycleRule;pub use request_lifecycle::WireInitialTurn;pub use request_lifecycle::rpc_request_lifecycle;pub use rest_catalog::RestOperationDescriptor;pub use rest_catalog::RestPathDescriptor;pub use rest_catalog::rest_documented_paths;pub use rest_catalog::rest_path_catalog;pub use rpc_catalog::RpcMethodCatalogOptions;pub use rpc_catalog::RpcMethodDescriptor;pub use rpc_catalog::RpcNotificationDescriptor;pub use rpc_catalog::rpc_method_catalog;pub use rpc_catalog::rpc_method_names;pub use rpc_catalog::rpc_notification_catalog;pub use rpc_catalog::rpc_notification_names;pub use session_locator::SessionLocator;pub use session_locator::SessionLocatorError;pub use session_locator::format_session_ref;pub use version::ContractVersion;pub use wire::ConfigWriteResult;pub use wire::supervisor_bridge::BridgeAck;pub use wire::supervisor_bridge::BridgeBindPayload;pub use wire::supervisor_bridge::BridgeBindResponse;pub use wire::supervisor_bridge::BridgeCapabilities;pub use wire::supervisor_bridge::BridgeCommand;pub use wire::supervisor_bridge::BridgeCommandDecodeError;pub use wire::supervisor_bridge::BridgeDeliveryOutcome;pub use wire::supervisor_bridge::BridgeDeliveryPayload;pub use wire::supervisor_bridge::BridgeDeliveryRejectionCause;pub use wire::supervisor_bridge::BridgeDeliveryResponse;pub use wire::supervisor_bridge::BridgeDestroyResponse;pub use wire::supervisor_bridge::BridgeHardCancelPayload;pub use wire::supervisor_bridge::BridgeMemberRuntimeState;pub use wire::supervisor_bridge::BridgeMobPeerOverlayHandoff;pub use wire::supervisor_bridge::BridgeObservationResponse;pub use wire::supervisor_bridge::BridgeOutboundTaintPayload;pub use wire::supervisor_bridge::BridgePeerConnectivity;pub use wire::supervisor_bridge::BridgePeerSpec;pub use wire::supervisor_bridge::BridgePeerWiringPayload;pub use wire::supervisor_bridge::BridgeProtocolVersion;pub use wire::supervisor_bridge::BridgeReply;pub use wire::supervisor_bridge::BridgeRetireResponse;pub use wire::supervisor_bridge::BridgeSupervisorPayload;pub use wire::supervisor_bridge::SUPERVISOR_BRIDGE_CURRENT_PROTOCOL_VERSION;pub use wire::supervisor_bridge::SUPERVISOR_BRIDGE_DEFAULT_PROTOCOL_VERSION;pub use wire::supervisor_bridge::SUPERVISOR_BRIDGE_PROTOCOL_VERSION;pub use wire::supervisor_bridge::SUPERVISOR_BRIDGE_SUPPORTED_PROTOCOL_VERSIONS;pub use wire::supervisor_bridge::UnsupportedBridgeProtocolVersion;pub use wire::supervisor_bridge::decode_bridge_command;pub use wire::supervisor_bridge::supervisor_bridge_current_protocol_version;pub use wire::supervisor_bridge::supervisor_bridge_default_protocol_version;pub use wire::supervisor_bridge::supervisor_bridge_protocol_version_supported;pub use wire::supervisor_bridge::supervisor_bridge_supported_protocol_versions;pub use wire::ApprovalDecideParams;pub use wire::ApprovalGetParams;pub use wire::ApprovalListParams;pub use wire::ApprovalListResult;pub use wire::ApprovalRequestParams;pub use wire::ArtifactDownloadParams;pub use wire::ArtifactDownloadResult;pub use wire::ArtifactIdParams;pub use wire::ArtifactListParams;pub use wire::ArtifactListResult;pub use wire::BindingIdParams;pub use wire::CatalogModelEntry;pub use wire::CommsChecksumTokenParams;pub use wire::CommsChecksumTokenResult;pub use wire::CommsChecksumTokenResultIntent;pub use wire::CommsCommandProjectionError;pub use wire::CommsCommandRequest;pub use wire::CommsParams;pub use wire::CommsPeerEntry;pub use wire::CommsPeerLifecycleParams;pub use wire::CommsPeerRequestParams;pub use wire::CommsPeerResponseResult;pub use wire::CommsPeerUnreachableReason;pub use wire::CommsPeersParams;pub use wire::CommsPeersResult;pub use wire::CommsSendErrorData;pub use wire::CommsSendParams;pub use wire::CommsSendResult;pub use wire::ConfigPatchParams;pub use wire::ConfigSetParams;pub use wire::CoreCreateParams;pub use wire::CreateProfileParams;pub use wire::DeviceCompleteParams;pub use wire::DeviceStartParams;pub use wire::EventReplayCursor;pub use wire::EventReplayCursorError;pub use wire::EventReplayEnvelope;pub use wire::EventReplayEventId;pub use wire::EventReplayScope;pub use wire::EventsLatestCursorParams;pub use wire::EventsLatestCursorResult;pub use wire::EventsListSinceParams;pub use wire::EventsListSinceResult;pub use wire::EventsSnapshotBody;pub use wire::EventsSnapshotParams;pub use wire::EventsSnapshotResult;pub use wire::ForkSessionAtParams;pub use wire::ForkSessionReplaceParams;pub use wire::HelpExecutionMode;pub use wire::HelpRequest;pub use wire::HelpResponse;pub use wire::HookParams;pub use wire::InterruptResult;pub use wire::ListSchedulesParams;pub use wire::ListSessionTranscriptRevisionsParams;pub use wire::LiveChannelParams;pub use wire::LiveCloseResult;pub use wire::LiveCloseStatus;pub use wire::LiveCommitInputParams;pub use wire::LiveCommitInputResult;pub use wire::LiveCommitInputStatus;pub use wire::LiveInputChunkWire;pub use wire::LiveInterruptResult;pub use wire::LiveInterruptStatus;pub use wire::LiveOpenParams;pub use wire::LiveOpenResult;pub use wire::LiveOpenTransport;pub use wire::LiveRefreshResult;pub use wire::LiveRefreshStatus;pub use wire::LiveSendInputParams;pub use wire::LiveSendInputResult;pub use wire::LiveSendInputStatus;pub use wire::LiveStatusResult;pub use wire::LiveTruncateParams;pub use wire::LiveTruncateResult;pub use wire::LiveTruncateStatus;pub use wire::LiveWebrtcAnswerParams;pub use wire::LiveWebrtcAnswerResult;pub use wire::LoginCompleteParams;pub use wire::LoginStartParams;pub use wire::McpAddParams;pub use wire::McpLiveOpResponse;pub use wire::McpLiveOpStatus;pub use wire::McpLiveOperation;pub use wire::McpReloadParams;pub use wire::McpRemoveParams;pub use wire::MobAppendSystemContextParams;pub use wire::MobAppendSystemContextResult;pub use wire::MobCancelAllWorkParams;pub use wire::MobCancelAllWorkResult;pub use wire::MobCancelWorkParams;pub use wire::MobCancelWorkResult;pub use wire::MobCreateParams;pub use wire::MobCreateResult;pub use wire::MobDefinitionInput;pub use wire::MobDestroyResult;pub use wire::MobEnsureMemberOutcomeWire;pub use wire::MobEnsureMemberParams;pub use wire::MobEnsureMemberResult;pub use wire::MobEventsParams;pub use wire::MobEventsResult;pub use wire::MobFlowCancelParams;pub use wire::MobFlowCancelResult;pub use wire::MobFlowRunParams;pub use wire::MobFlowRunResult;pub use wire::MobFlowStatusParams;pub use wire::MobFlowStatusResult;pub use wire::MobFlowsResult;pub use wire::MobForceCancelResult;pub use wire::MobForkHelperParams;pub use wire::MobHelperResult;pub use wire::MobIdParams;pub use wire::MobIngressInteractionParams;pub use wire::MobIngressInteractionResult;pub use wire::MobLifecycleParams;pub use wire::MobLifecycleResult;pub use wire::MobListMembersMatchingParams;pub use wire::MobListMembersMatchingResult;pub use wire::MobListResult;pub use wire::MobMemberFilterWire;pub use wire::MobMemberListEntryWire;pub use wire::MobMemberParams;pub use wire::MobMemberSendParams;pub use wire::MobMemberSendResult;pub use wire::MobMemberSpecWire;pub use wire::MobMemberStatusResult;pub use wire::MobMembersResult;pub use wire::MobPeerTarget;pub use wire::MobProfileCreateParams;pub use wire::MobProfileDeleteParams;pub use wire::MobProfileDeleteResult;pub use wire::MobProfileInput;pub use wire::MobProfileListResult;pub use wire::MobProfileLookupResult;pub use wire::MobProfileNameParams;pub use wire::MobProfileUpdateParams;pub use wire::MobReconcileFailureWire;pub use wire::MobReconcileOptionsWire;pub use wire::MobReconcileParams;pub use wire::MobReconcileReportWire;pub use wire::MobReconcileResult;pub use wire::MobRespawnParams;pub use wire::MobRespawnReceipt;pub use wire::MobRespawnResult;pub use wire::MobRetireResult;pub use wire::MobRotateSupervisorResult;pub use wire::MobRunParams;pub use wire::MobRunResult;pub use wire::MobRunResultParams;pub use wire::MobSnapshotResult;pub use wire::MobSpawnHelperParams;pub use wire::MobSpawnManyFailedResult;pub use wire::MobSpawnManyFailureCause;pub use wire::MobSpawnManyParams;pub use wire::MobSpawnManyResult;pub use wire::MobSpawnManyResultEntry;pub use wire::MobSpawnManyResultPayload;pub use wire::MobSpawnManyResultStatus;pub use wire::MobSpawnManySpawnedResult;pub use wire::MobSpawnParams;pub use wire::MobSpawnReceiptWire;pub use wire::MobSpawnResult;pub use wire::MobSpawnSpecParams;pub use wire::MobStatusResult;pub use wire::MobStreamCloseParams;pub use wire::MobStreamCloseResult;pub use wire::MobStreamOpenParams;pub use wire::MobStreamOpenResult;pub use wire::MobSubmitWorkParams;pub use wire::MobSubmitWorkResult;pub use wire::MobTurnStartParams;pub use wire::MobUnwireParams;pub use wire::MobUnwireResult;pub use wire::MobWaitMembersResult;pub use wire::MobWaitParams;pub use wire::MobWireMembersBatchEdge;pub use wire::MobWireMembersBatchParams;pub use wire::MobWireMembersBatchResult;pub use wire::MobWireParams;pub use wire::MobWireResult;pub use wire::ModelsCatalogResponse;pub use wire::PeerResponseTerminalStatusWire;pub use wire::ProviderCatalog;pub use wire::ProvisionApiKeyParams;pub use wire::ReadSessionTranscriptRevisionParams;pub use wire::RealmIdParams;pub use wire::RealtimeAudioChunk;pub use wire::RealtimeAudioFormat;pub use wire::RealtimeCapabilities;pub use wire::RealtimeInputChunk;pub use wire::RealtimeInputKind;pub use wire::RealtimeOutputKind;pub use wire::RealtimeTextChunk;pub use wire::RealtimeTurningMode;pub use wire::RealtimeVideoChunk;pub use wire::RestoreSessionTranscriptRevisionParams;pub use wire::RevisionId;pub use wire::RevisionSelector;pub use wire::RewriteSessionTranscriptParams;pub use wire::RuntimeAcceptOutcomeType;pub use wire::RuntimeAcceptResult;pub use wire::RuntimeHostCapabilities;pub use wire::RuntimeHostEndpointProjection;pub use wire::RuntimeHostFeatureFlags;pub use wire::RuntimeHostHealth;pub use wire::RuntimeHostHealthStatus;pub use wire::RuntimeHostIdScope;pub use wire::RuntimeHostInfo;pub use wire::RuntimeHostRealmProjection;pub use wire::RuntimeStateResult;pub use wire::ScheduleIdParams;pub use wire::ScheduleListResult;pub use wire::ScheduleOccurrencesParams;pub use wire::ScheduleOccurrencesResult;pub use wire::ServerCapabilities;pub use wire::ServerInfo;pub use wire::SessionExternalEventEnvelope;pub use wire::SessionInputStateParams;pub use wire::SessionInputStateResult;pub use wire::SessionInputStateSelector;pub use wire::SessionPeerResponseTerminalParams;pub use wire::SessionStreamCloseParams;pub use wire::SessionStreamCloseResult;pub use wire::SessionStreamOpenParams;pub use wire::SessionStreamOpenResult;pub use wire::SkillEntry;pub use wire::SkillInspectResponse;pub use wire::SkillListResponse;pub use wire::SkillSourceProvenance;pub use wire::SkillsParams;pub use wire::StreamReadStatus;pub use wire::StructuredOutputParams;pub use wire::SupervisorRotationIncompleteDataWire;pub use wire::SupervisorRotationIncompleteDetailsWire;pub use wire::SupervisorRotationIncompleteKind;pub use wire::SupervisorRotationReportWire;pub use wire::SupervisorRotationRetryAuthority;pub use wire::SupervisorRotationRetryScope;pub use wire::TranscriptRewriteMessage;pub use wire::UpdateScheduleParams;pub use wire::WireAgentRuntimeId;pub use wire::WireAppendSystemContextStatus;pub use wire::WireAssistantBlock;pub use wire::WireAssistantImageRef;pub use wire::WireAuthBindingRef;pub use wire::WireAuthError;pub use wire::WireAuthProfile;pub use wire::WireAuthProfileCleared;pub use wire::WireAuthProfileCreated;pub use wire::WireAuthProfileDetail;pub use wire::WireAuthProfilesList;pub use wire::WireAuthStatus;pub use wire::WireAuthStatusDetail;pub use wire::WireBackendProfile;pub use wire::WireBindingIdentity;pub use wire::WireCallbackPending;pub use wire::WireCallbackPendingStatus;pub use wire::WireContentBlock;pub use wire::WireContentInput;pub use wire::WireDeviceCompleteResult;pub use wire::WireDeviceStart;pub use wire::WireEvent;pub use wire::WireGenerateImageExecutionPlan;pub use wire::WireGenerateImageRequest;pub use wire::WireHandlingMode;pub use wire::WireImageGenerationToolResult;pub use wire::WireImageOperationPhase;pub use wire::WireInputLifecycleState;pub use wire::WireInputState;pub use wire::WireInputStateHistoryEntry;pub use wire::WireInterruptOutcome;pub use wire::WireLiveAdapterErrorCode;pub use wire::WireLiveAdapterObservation;pub use wire::WireLiveAdapterStatus;pub use wire::WireLiveChannelCapabilities;pub use wire::WireLiveChannelCloseFailure;pub use wire::WireLiveChannelRefreshFailure;pub use wire::WireLiveCloseFailure;pub use wire::WireLiveConfigPropagationReport;pub use wire::WireLiveContinuityMode;pub use wire::WireLiveDegradationReason;pub use wire::WireLiveHotSwapSkip;pub use wire::WireLiveHotSwapSkipReason;pub use wire::WireLiveRefreshFailure;pub use wire::WireLiveResponseModality;pub use wire::WireLiveSwapFailure;pub use wire::WireLiveTransportBootstrap;pub use wire::WireLoginReady;pub use wire::WireLoginStart;pub use wire::WireMemberRef;pub use wire::WireMemberRefError;pub use wire::WireMobBackendKind;pub use wire::WireMobError;pub use wire::WireMobLifecycleAction;pub use wire::WireMobLifecycleStatus;pub use wire::WireMobMemberStatus;pub use wire::WireMobProfile;pub use wire::WireMobReconcileStage;pub use wire::WireMobRespawnOutcome;pub use wire::WireMobResumeOverrideField;pub use wire::WireMobRun;pub use wire::WireMobRunResultEnvelope;pub use wire::WireMobRunStatus;pub use wire::WireMobRuntimeMode;pub use wire::WireMobToolConfig;pub use wire::WireMobWireAction;pub use wire::WireModelBetaHeader;pub use wire::WireModelProfile;pub use wire::WireModelRoutingApprovalPhase;pub use wire::WireModelTier;pub use wire::WirePeerConnectivity;pub use wire::WirePeerConnectivitySnapshot;pub use wire::WirePendingToolCall;pub use wire::WirePromptInput;pub use wire::WireProviderBinding;pub use wire::WireProviderMeta;pub use wire::WireProvisionApiKeyResult;pub use wire::WireRealmConnectionSet;pub use wire::WireRealmList;pub use wire::WireRealmSummary;pub use wire::WireRenderClass;pub use wire::WireRenderMetadata;pub use wire::WireRenderSalience;pub use wire::WireResolvedModelCapabilities;pub use wire::WireRunResult;pub use wire::WireRuntimeBinding;pub use wire::WireRuntimeState;pub use wire::WireScopedModelOverride;pub use wire::WireSessionHistory;pub use wire::WireSessionInfo;pub use wire::WireSessionMessage;pub use wire::WireSessionModelRoutingStatus;pub use wire::WireSessionSummary;pub use wire::WireSessionTranscriptRevision;pub use wire::WireSessionTranscriptRevisionEntry;pub use wire::WireSessionTranscriptRevisionList;pub use wire::WireStopReason;pub use wire::WireSwitchTurnControlResult;pub use wire::WireSwitchTurnIntent;pub use wire::WireSwitchTurnPhase;pub use wire::WireToolResult;pub use wire::WireToolResultContent;pub use wire::WireTrustedPeerIdentity;pub use wire::WireTrustedPeerSpec;pub use wire::WireUnreachablePeer;pub use wire::WireUsage;pub use wire::WireWorkOrigin;pub use wire::WorkEventsResult;pub use wire::WorkItemsResult;
Modules§
- capability
- Capability wire projections for Meerkat.
- error
- Typed error envelope for all Meerkat protocol surfaces.
- event_
catalog - protocol
- Protocol surface enumeration.
- request_
lifecycle - rest_
catalog - Canonical REST surface catalog.
- rpc_
catalog - session_
locator - Canonical session locator grammar shared across surfaces.
- version
- Contract versioning for Meerkat wire protocol.
- wire
- Canonical wire response types.
Structs§
- Approval
Decision Record - Durable decision audit record.
- Approval
Id - Durable approval id.
- Approval
List Filter - Filter for listing approvals.
- Approval
Member Ref - Typed reference to a mob member owning an approval.
- Approval
MobRef - Typed reference to a mob owning an approval.
- Approval
Principal Id - Principal identifier used for requester and decision actor projections.
- Approval
Proposed Action - Action proposed by the requester.
- Approval
Record - Durable approval record.
- Approval
Request - Input used by tools/runtime code to request an approval.
- Approval
Resource Id - Typed identifier for the resource affected by an approval.
- Approval
Resource Ref - Resource affected by an approval.
- Auth
Grant - A typed grant issued to a principal for a single scope.
- Capability
Registration - Self-registration entry for a capability.
- Execution
Placement - Structured metadata for where a tool or shell command executed.
- Execution
Placement Identity - Stable, non-path placement identity facts.
- Peer
Address - Typed peer address: transport atom plus endpoint string.
- Peer
Capability Set - Typed peer capability envelope for peer-directory output.
- Peer
Directory Entry - Peer
Directory Listing - PeerId
- Canonical runtime identity for a peer.
- Principal
Id - Stable, caller-visible principal id.
- Principal
Ref - Typed principal reference.
- Session
Fork Result - Result of creating an edited transcript branch.
Enums§
- Approval
Action Kind - Typed action kind for the proposed action.
- Approval
Decision - Allowed terminal decisions.
- Approval
Owner Ref - Typed owner for an approval request.
- Approval
Resource Kind - Typed resource kind affected by an approval.
- Approval
Risk - Risk classification for an approval request.
- Approval
Status - Approval record status.
- Capability
Id - Every capability known to Meerkat. Adding a variant forces updates to the registry, error mappings, and codegen templates.
- Capability
Scope - Where a capability applies.
- Capability
Status - Runtime status of a capability.
- Comms
Command Error - Cross-field validation failure for
CommsCommandRequest::into_command. - Comms
Peer Request Intent - Closed request-intent vocabulary for
CommsCommandRequest::PeerRequest. - Grant
Action - Actions that grants may allow. Enforcement sites decide which action is needed for a specific operation.
- Grant
Scope - Generic scope for grants and shared visibility.
- Peer
Directory Source - Peer
Sendability - Peer
Transport - Typed transport atom for a peer address.
- Principal
Kind - Generic principal categories. Product-specific role names belong outside core and may be mapped to these typed categories by clients.
- Send
Taint Override - Per-send tri-state override for the outbound content-taint declaration.
- Sender
Content Taint - Sender-declared content-taint classification for peer content.
- Transcript
Edit Running Behavior - Explicit behavior for transcript fork/edit requests when the source session has active work.
- Transcript
Replacement - Typed transcript replacement used to create an edited fork.
- Visibility
Class - Typed visibility class for events, artifacts, approvals, or future records.
Functions§
- available_
capabilities - Return the capability ids that are effectively available after config-level status resolution has been applied.
- build_
capabilities - Collect all registered capabilities, sorted by
CapabilityIdordinal for deterministic ordering regardless ofinventorycollection order. - resolve_
capabilities - Resolve runtime status for every registered capability against the current config. This is the single config-aware capability truth used by both surface reporting and skill filtering.