Agentic.Persistence.Plan behaviour (agentic v0.2.2)

Copy Markdown

Behaviour for CRUD operations on structured plans with step-level status tracking.

The :local implementation stores JSON files at <workspace>/.agentic/plans/<plan_id>.json.

Summary

Types

plan_struct()
plan_summary()
step_struct()

Callbacks

create(plan, opts)
get(plan_id, opts)
list_plans(workspace, opts)
update_step(plan_id, step_index, updates, opts)

Types

plan_struct()

@type plan_struct() :: %{id: String.t(), goal: String.t(), steps: [step_struct()]}

plan_summary()

@type plan_summary() :: %{
  id: String.t(),
  goal: String.t(),
  step_count: non_neg_integer(),
  completed_count: non_neg_integer()
}

step_struct()

@type step_struct() :: %{
  index: non_neg_integer(),
  description: String.t(),
  tools: [String.t()],
  verification: String.t(),
  status: :pending | :in_progress | :complete | :failed
}

Callbacks

create(plan, opts)

@callback create(plan :: plan_struct(), opts :: keyword()) ::
  {:ok, plan_struct()} | {:error, term()}

get(plan_id, opts)

@callback get(plan_id :: String.t(), opts :: keyword()) ::
  {:ok, plan_struct()} | {:error, :not_found}

list_plans(workspace, opts)

@callback list_plans(workspace :: String.t(), opts :: keyword()) ::
  {:ok, [plan_summary()]} | {:error, term()}

update_step(plan_id, step_index, updates, opts)

@callback update_step(
  plan_id :: String.t(),
  step_index :: integer(),
  updates :: map(),
  opts :: keyword()
) :: {:ok, plan_struct()} | {:error, term()}