@callback handle_file_read(
  session_id :: String.t(),
  path :: String.t(),
  opts :: map(),
  state()
) ::
  {:ok, content :: String.t(), state()}
  | {:error, reason :: String.t(), state()}

Called when the agent requests to read a file.

Return {:ok, content, state} with the file contents, or {:error, reason, state} to deny access.

@callback handle_file_write(
  session_id :: String.t(),
  path :: String.t(),
  content :: String.t(),
  state()
) :: {:ok, state()} | {:error, reason :: String.t(), state()}

Called when the agent requests to write a file.

Return {:ok, state} to allow the write, or {:error, reason, state} to deny it.

@callback handle_permission_request(
  session_id :: String.t(),
  tool_call :: map(),
  options :: [map()],
  state()
) :: {:ok, outcome :: map(), state()}

Called when the agent requests permission to use a tool.

Must return an outcome map with an "optionId" matching one of the provided options.

@callback handle_session_update(session_id :: String.t(), update :: map(), state()) ::
  {:ok, state()}

Called for each session/update notification from the agent.

The update map contains a "sessionUpdate" discriminator field indicating the update type (e.g., "agent_message_chunk", "tool_call", "plan", etc.).

@callback init(opts :: keyword()) :: {:ok, state()}

Called when the handler is initialized.

@callback terminate(reason :: any(), state()) :: :ok

Called when the handler is being terminated.