Skip to main content

Overview

sync is the primary context-loading tool. It reports what the agent is currently working on and returns the full workspace state in a single call — agents, decisions, conflicts, file reservations, work packages, and branch directives. Agents typically call sync at the start of a task and when they need a context refresh mid-session. Session management (creation, heartbeat, termination) is handled automatically by IDE hooks — sync is for explicit context requests.

Parameters

Response

Response Fields

Example

When to Call sync

  • Start of a task — get current team context before writing any code
  • Before touching a new area — check for conflicts and existing decisions
  • After a long pause — refresh context if the session has been idle
  • When the agent mentions uncertainty — “I’m not sure how the team handles auth” → call sync
Pass the session_id from each response back into the next call. This ensures your activity is tracked against the same session rather than creating a new one each time.