Reference · Protocol ara-ep/1
Protocol methods
The Engine Protocol is what the editor, the CLI and agents speak to a project's daemon; the MCP tools are built on it. Most calls take a session handle from session.begin.
branch
- branch.discardThrow a branch session away (its owner or a human).
- branch.listEvery branch session with its status and changes.
- branch.mergeApprove and merge a branch session now (humans only): field-level three-way merge with a conflict report.
- branch.openOpen a branch session: a private copy of the live documents to apply your turn in (ara_apply with branch); nothing is live until it is submitted and merged.
- branch.statusOne branch session: status, what it changed (was → now), what it waits on, the merge report.
- branch.submitSubmit your optional branch session and merge it immediately.
cmd
collab
- collab.activityConnected participants and their current presence for Ara Hub.
- collab.claimClaim entities, components, documents or files for your turn, with an expiry. Advisory only; never blocks edits.
- collab.claimsEvery live claim, structured.
- collab.conflictsThe conflict log: changes that lost (overwritten, dropped, kept-live in a merge), with both values.
- collab.heartbeatExtend your claims by their lifetime.
- collab.joinJoin collaboration: this connection gets presence, claims, op and conflict notifications; returns everyone's state (and a snapshot on request).
- collab.leaveLeave collaboration: releases your claims and clears your presence.
- collab.presenceSet your presence (open document, camera, selection, pointer, activity, following); broadcast rate-limited. Also a heartbeat for your claims.
- collab.redoRedo your latest collab undo.
- collab.releaseRelease your claims (all, or by ID).
- collab.submitSubmit a replica's optimistic edits: merged field-level onto everything since base; the same field is last-writer-wins and the loser is logged.
- collab.syncOp events after a revision (replay), or a snapshot of every document (late join, resync).
- collab.undoUndo your latest change without undoing anyone else's: fields others changed since keep their value.
- collab.whoWho is here and doing what: participants, what they look at and do, their advisory presence and branch sessions, as short text.
daemon
diag
- diag.clearForget matching diagnostics (all without filters).
- diag.queryDiagnostics on the bus by code, severity, subject, origin, time or tick; grouped and budgeted by default.
- diag.reportPush diagnostics from another process (player, import worker) onto this host's bus.
- diag.subscribeStream matching diagnostics to this connection as diag.event notifications.
- diag.unsubscribeStop a diag.subscribe stream.
doc
docs
editor
history
inspect
jobs
logs
profile
query
review
rpc
schema
session
- session.beginBegin a session: returns the handle every other call takes, and the scopes granted.
- session.checkpointMark the current revision to roll back to. Agent turns get one automatically.
- session.diffWhat the session changed since a checkpoint, per entity, with was → now per field.
- session.endEnd the session; its handle stops working.
- session.rollbackUndo every transaction of this session after a checkpoint, all or nothing.
- session.statusThe session's scopes, turns, unreviewed changes, checkpoints and unsaved documents.