Pi.Plugin behaviour (pi_bridge v0.6.22)

Behaviour for supervised pi_bridge plugins.

Summary

command_result()

apis()

commands()

init(keyword)

shutdown(term)

api(attrs)

command(attrs)

@type command_result() :: {:ok, String.t()} | {:error, String.t()} | String.t()

@type tool_call_result() :: :ok | {:ok, map()} | {:block, String.t()}

@type tool_result_result() :: :ok | {:ok, map()}

(optional)

@callback apis() :: [Pi.Plugin.API.t() | keyword() | map()]

(optional)

@callback commands() :: [Pi.Plugin.Command.t() | keyword() | map()]

(optional)

@callback handle_command(atom(), String.t(), term()) ::
  {command_result(), term()} | command_result()

(optional)

@callback handle_event(map(), term()) :: {:noreply, term()} | term()

(optional)

@callback init(keyword()) :: {:ok, term()} | {:error, term()} | term()

(optional)

@callback shutdown(term()) :: :ok | term()

(optional)

@callback tool_call(map(), map(), term()) ::
  {tool_call_result(), term()} | tool_call_result()

(optional)

@callback tool_result(map(), map(), term()) ::
  {tool_result_result(), term()} | tool_result_result()