mhome-conversation-api
Typed, transport-neutral DTOs and canonical surface identities for the mHome conversation API.
This crate owns wire targets, request and response bodies, user-visible message content, and
conversation events. ConversationSurface is a canonical value object whose string form is the
wire and persistence identity of one isolated conversation endpoint. The crate deliberately
contains no Agent runtime, persistence, transport implementation, or messaging-provider SDK.
/chat/turn/submit is the source-neutral application operation for callers that do not manage
threads themselves. The Conversation implementation owns active-thread creation, idle rotation,
pending-interaction policy, idempotency, and enqueueing for that operation.
The canonical cs1 surface families are client personal (cp), client group (cg), messaging
personal (mp), and messaging group (mg). Messaging surfaces include provider, provider account,
external conversation, and an optional lane. A lane isolates a provider sub-conversation such as a
Telegram forum topic without changing the provider account's base authorization route.
Message content is a provider-independent ordered list of text, image, audio, video, and file parts. Messaging runtimes must materialize provider media handles into this content before invoking the Conversation application port; the Agent and this contract never receive provider SDK objects.
Execution contracts
execution owns Agent command/event DTOs and deployment ports. execution::wire owns the cloud
transport envelopes and schema/execution / fixtures/execution conformance assets. These moved
from the retired Agent contract/protocol crates. Client-facing root modules remain unchanged.
Model data is re-exported from llm-api; there is one model-message representation. User-facing
messages intentionally use separate content types and never contain private model continuation.
Runtime state machines, checkpoint formats, prompts and recovery policy remain in Agent Runtime.
RunErrorCode is the closed catalog for runOutcome.errorCode and Agent Failed.code. Host
terminalize and Agent failures emit the same strings. status and failure.source are properties
of the code; failure.code equals errorCode. User-visible copy stays in runOutcome.message,
not in this crate. Command /chat/* errors and adapter ExternalErrorKind are separate layers.
Cloud admission model snapshot
Every cloud LlmRoute carries a required model_snapshot containing confirmed capabilities
and catalog generation_support (the camelCase metadata.generationSupport shape). Lion
persists it with desired parameters at request admission. Deployments adapt preferences against
these immutable facts; tool rounds and approval resumption never rediscover current metadata.
The portable CompletionRequest and its caller-owned constraints remain separate from this
snapshot. Version 3 stores capabilities.input as image|video|audio|file instead of
vision: bool. An old plan without the snapshot, or with vision, fails decoding instead
of silently changing behavior. This development contract change must be published and
adopted by Lion and Cloud together before deployment.
Strict execution envelope decoding
Execution commands, events, facade responses and their typed nested objects reject undeclared fields, including null-valued unknown fields. Opaque JSON inputs/results and model continuation payloads remain extensible; known optional null fields remain accepted. Enforcement lives on the typed DTOs as well as the wire entry point because Serde's internally tagged enum buffering bypasses an outer serde_ignored observer. Tagged unit variants explicitly require an empty remaining map. This restores the existing wire-v1 contract without changing its message shape or major version.
Disposable execution presentation
assistant.preview, run.progress, and run.system_failed are best-effort live
presentation. They are not replayed by thread/load, which has no live field.
Each event replaces its display slot completely; preview text never appends and
is capped by the host at 8,192 Unicode characters. Clients retain at most one
event per slot, scoped to the active request and baseSnapshotVersion.
sequence is assigned by the execution owner, may contain gaps, and only rejects
older or duplicate events in the same slot. A missing presentation event must not
trigger history resynchronization. A new snapshot generation resets ordering;
terminal or pending-interaction control clears presentation. Joining or reconnecting
starts from durable history/control and future live events, with a generic running
indicator until a new presentation arrives.
Final replies, failures, cancellations, queue state, and actionable user confirmations remain durable. Snapshot deltas keep their existing contiguous version/recovery rules. Agent checkpoints and billing are independent of live presentation delivery.