Protocol Reference

The protocol is the stable terminal contract agents use to work with tickets.

Core commands

The protocol surface currently includes:

  • auth-status
  • discover-project
  • attach
  • connect
  • load-context
  • create
  • prompt
  • record-work
  • update
  • heartbeat
  • record-change-rationales
  • ask
  • permission-request
  • read-context
  • write-context
  • deliver
  • artifact upload and download helpers

What these commands do

They let an agent resolve the right project, bind to a ticket, report progress, send liveness heartbeats, persist file-level rationale, share reusable context, manage artifacts, ask for help, request tool permission, and return final work in a structured way.

create vs. prompt

Both create tickets from an agent session, but they differ in intent:

  • create produces a draft ticket without attaching. This is the default path for capturing follow-up work from within an existing session.
  • prompt creates a ticket in execute status and immediately attaches the current session. Use it when the agent should start work on the new ticket right away.
  • record-work records work the agent already completed in chat. It creates the ticket directly in review with a completed objective, no open session, and triggers a feed post. Use it instead of create + attach + deliver for "log what we just did" flows.