This module defines the behaviour for tool calls. Defining a new tool requires implementing the spec/0 and call/2 functions.

The spec/0 function should return a map that describes the tool's capabilities and arguments, using a map to represent the OpenAPI spec.

The call/2 function generates the tool call response. It accepts the requesting AI.Completion's struct and a map derived from the parsed JSON provided by the agent, containing the tool call arguments. Note that, because the arguments are parsed from JSON, the keys will all be strings. Whether those are converted to symbols is between the tool implementation and the code it calls. What happens behind closed APIs is none of MY business.

Skeleton Implementation

defmodule AI.Tools.MyNewTool do
  @behaviour AI.Tools

  @impl AI.Tools
  def async?(), do: true

  @impl AI.Tools
  def ui_note_on_request(_args) do
    {"Doing something", "This tool is doing something."}
  end

  @impl AI.Tools
  def ui_note_on_result(_args, _result) do
    {"Did something", "This tool did something."}
  end

  @impl AI.Tools
  def read_args(args) do
    {:ok, args}
  end

  @impl AI.Tools
  def spec() do
    %{
      type: "function",
      function: %{
        name: "something_tool",
        description: "This tool does something.",
        strict: true,
        parameters: %{
          additionalProperties: false,
          type: "object",
          required: ["thing"],
          properties: %{
            thing: %{
              type: "string",
              description: "The thing to do."
            }
          }
        }
      }
    }
  end

  @impl AI.Tools
  def call(args) do
    {:ok, "IMPLEMENT ME"}
  end
end