tools

Documentation

Overview

Package tools defines a standard interface for tools to be used by agents.

Index

• type Calculator
  • func (c Calculator) Call(ctx context.Context, input string) (string, error)
  • func (c Calculator) Description() string
  • func (c Calculator) Name() string
• type InjectedToolArg
• type InjectedToolCallID
• type Tool
  • func InjectArgs(tool Tool, args map[string]any) Tool
  • func InjectID(tool Tool, getID func() string) Tool
• type ToolCallContext
  • func (c ToolCallContext) GetInjectedArg(name string) (any, bool)

Types

type Calculator

type Calculator struct {
	CallbacksHandler callbacks.Handler
}

Calculator is a tool that can do math.

func (Calculator) Call

func (c Calculator) Call(ctx context.Context, input string) (string, error)

Call evaluates the input using a starlak evaluator and returns the result as a string. If the evaluator errors the error is given in the result to give the agent the ability to retry.

func (Calculator) Description

func (c Calculator) Description() string

Description returns a string describing the calculator tool.

func (Calculator) Name

func (c Calculator) Name() string

Name returns the name of the tool.

type InjectedToolArg

type InjectedToolArg struct {
	Value any
}

InjectedToolArg is a marker type for tool arguments that are injected at runtime rather than supplied by the model. It mirrors langchain_core.tools.InjectedToolArg. Declaring a parameter of this type in a tool's schema tells the model to ignore it, and the runtime fills it in.

type InjectedToolCallID

type InjectedToolCallID struct {
	Value string
}

InjectedToolCallID is a marker type for the ID of the tool call being executed, injected at runtime. It mirrors langchain_core.tools.InjectedToolCallId.

type Tool

type Tool interface {
	Name() string
	Description() string
	Call(ctx context.Context, input string) (string, error)
}

Tool is a tool for the llm agent to interact with different applications.

func InjectArgs

func InjectArgs(tool Tool, args map[string]any) Tool

InjectArgs wraps a tool so that the provided arguments are injected into its JSON input before execution.

func InjectID

func InjectID(tool Tool, getID func() string) Tool

InjectID wraps a tool so that the invoking tool call ID is injected into its input. The input is expected to be JSON; the "tool_call_id" field is set (or replaced) with the given ID.

type ToolCallContext

type ToolCallContext struct {
	// CallID is the ID of the tool call that is being executed.
	CallID string
	// Args holds injected arguments keyed by name.
	Args map[string]any
}

ToolCallContext carries the runtime-injected values available to a tool call.

func (ToolCallContext) GetInjectedArg

func (c ToolCallContext) GetInjectedArg(name string) (any, bool)

GetInjectedArg returns the injected argument for name, if present.