Cyclium.Tool behaviour (Cyclium v0.1.5)

Behaviour for tool implementations. Tools are provided by the consuming app and wrapped by ToolExec.

Minimal implementation

defmodule MyApp.Tools.ERP do
  use Cyclium.Tool

  def call(:read_po, args, _ctx), do: {:ok, fetch_po(args["po_id"])}
end

use Cyclium.Tool provides sensible defaults for all optional callbacks. Override any of them as needed.

cache_ttl()

redact(args)

side_effect?()

@callback cache_scope(args :: map()) :: binary()

@callback cache_ttl() :: non_neg_integer() | :no_cache

@callback call(action :: atom(), args :: map(), ctx :: map()) ::
  {:ok, result :: term()} | {:error, reason :: term()}

@callback redact(args :: map()) :: map()

@callback redact_result(result :: term()) :: term()

@callback side_effect?() :: boolean()