← back to examples
core beginner

State Ops Agent

Focused example for SetState, ReplaceState, DeleteKeys, SetPath, and DeletePath via pure cmd execution.

state stateops actions core-mechanics l1

Related guides and notebooks

Concept
Agents
Review agent state model and immutability.
Concept
Actions
Understand action contracts and result handling.
Next
Build your first workflow
Compose multiple state mutations into workflows.
Livebook
Build your first workflow
Run the companion notebook in Livebook
Explanation

What this example teaches

Interactive Demo

Run the agent and inspect state

Source Code

Read the production implementation

state_ops_agent.ex merge_metadata_action.ex replace_all_action.ex set_nested_value_action.ex state_ops_agent_live.ex
lib/agent_jido/demos/state_ops/state_ops_agent.ex 38 lines 
defmodule AgentJido.Demos.StateOpsAgent do
  @moduledoc """
  Demo agent for `StateOp` mutation patterns.
  """

  alias AgentJido.Demos.StateOps.{
    ClearTempDataAction,
    DeleteNestedValueAction,
    MergeMetadataAction,
    ReplaceAllAction,
    SetNestedValueAction
  }

  use Jido.Agent,
    name: "state_ops_agent",
    description: "Demonstrates SetState/ReplaceState/DeleteKeys/SetPath/DeletePath",
    schema: [
      counter: [type: :integer, default: 0],
      name: [type: :string, default: "demo"],
      metadata: [type: :map, default: %{}],
      temp: [type: :any, default: "scratch"],
      cache: [type: :any, default: %{hot: true}],
      config: [type: :map, default: %{timeout: 1000, secret: "token"}],
      step: [type: :atom, default: :idle]
    ],
    signal_routes: [
      {"state.merge_metadata", MergeMetadataAction},
      {"state.replace_all", ReplaceAllAction},
      {"state.clear_temp", ClearTempDataAction},
      {"state.set_nested", SetNestedValueAction},
      {"state.delete_nested", DeleteNestedValueAction}
    ]

  @doc false
  @spec plugin_specs() :: nonempty_list(Jido.Plugin.Spec.t())
  def plugin_specs, do: super()
end