Backplane.AgentRuntime.Tools behaviour (backplane_agent_runtime v1.6.0)

Copy Markdown

Backend-conditional optional tool family wrappers.

Each family is omitted until its port is explicitly configured. The wrapper never creates an alternate executor, service backend, or elevated authority.

Summary

Types

t()

@type t() :: map()

Callbacks

memory_search(t, map, map, keyword)

@callback memory_search(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

memory_store(t, map, map, keyword)

@callback memory_store(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

skill_list(t, map, map, keyword)

@callback skill_list(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

skill_load(t, map, map, map, keyword)

@callback skill_load(t(), map(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

Functions

available_tools(tools)

@spec available_tools(t()) :: [atom()]

command_cancel(tools, caller, invocation, job)

@spec command_cancel(t(), map(), map(), map()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

command_read(tools, caller, invocation, job, opts \\ [])

@spec command_read(t(), map(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

command_start(tools, caller, invocation, opts \\ [])

@spec command_start(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

memory_search(tools, caller, query, opts \\ [])

@spec memory_search(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

memory_store(tools, caller, record, opts \\ [])

@spec memory_store(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

new(namespace)

@spec new(map()) :: {:ok, t()}

plan_read(tools, caller)

@spec plan_read(t(), map()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

plan_update(tools, caller, expected_revision, content)

@spec plan_update(t(), map(), integer(), map()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

resource_read(tools, caller, reference, opts \\ [])

@spec resource_read(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

resource_write(tools, caller, reference, content, opts \\ [])

@spec resource_write(t(), map(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

skill_list(tools, caller, query \\ %{}, opts \\ [])

@spec skill_list(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

skill_load(tools, caller, descriptor, resource, opts \\ [])

@spec skill_load(t(), map(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}