llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.toolapi/org.llm4s.toolapi.builtin/org.llm4s.toolapi.builtin.core

org.llm4s.toolapi.builtin.core

package org.llm4s.toolapi.builtin.core

Core utility tools that require no external dependencies or API keys.

These tools provide common functionality for agent workflows:

Attributes

Example 
import org.llm4s.toolapi.builtin.core._
import org.llm4s.toolapi.ToolRegistry
// Recommended: Safe API returning Result
for {
 dateTime   <- DateTimeTool.toolSafe
 calculator <- CalculatorTool.toolSafe
 uuid       <- UUIDTool.toolSafe
 json       <- JSONTool.toolSafe
} yield new ToolRegistry(Seq(dateTime, calculator, uuid, json))
// Or use the convenience val
allToolsSafe.map(tools => new ToolRegistry(tools))

Members list

Type members

Classlikes

case class CalculatorResult(expression: String, result: Double, formatted: String)

Result from calculator operations.

Result from calculator operations.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CalculatorResult

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object CalculatorTool

Tool for performing mathematical calculations.

Tool for performing mathematical calculations.

Supports:

  • Basic arithmetic: add, subtract, multiply, divide
  • Power and square root
  • Percentage calculations
  • Absolute value, min, max

A result that is not a finite number (an overflow such as 10^400, or an undefined power such as (-8)^(1/3)) is reported as an error, as division by zero is. The formatted text always uses . as the decimal separator and ASCII digits, whatever the JVM's default locale is.

Attributes

Example 
import org.llm4s.toolapi.builtin.core.CalculatorTool
val tools = new ToolRegistry(Seq(CalculatorTool.tool))
agent.run("What is 15% of 250?", tools)
Supertypes
class Object
trait Matchable
class Any
Self type
case class DateTimeComponents(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Int, dayOfWeek: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DateTimeResult(datetime: String, timezone: String, timestamp: Long, iso8601: String, components: DateTimeComponents)

Result from date/time operations.

Result from date/time operations.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DateTimeResult

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object DateTimeTool

Tool for getting current date and time information.

Tool for getting current date and time information.

Features:

  • Current date/time in any timezone
  • Multiple output formats (ISO, human-readable)
  • Timestamp conversion
  • Date component extraction

Attributes

Example 
import org.llm4s.toolapi.builtin.core.DateTimeTool
val tools = new ToolRegistry(Seq(DateTimeTool.tool))
agent.run("What is the current time in Tokyo?", tools)
Supertypes
class Object
trait Matchable
class Any
Self type
case class JSONResult(success: Boolean, result: Value, formatted: String)

Result from JSON operations.

Result from JSON operations.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object JSONResult

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
JSONResult.type
object JSONTool

Tool for JSON parsing, formatting, and querying.

Tool for JSON parsing, formatting, and querying.

Operations:

  • parse: Parse JSON string into structured data
  • format: Pretty-print JSON
  • query: Extract value using path (e.g., "data.users[0].name")
  • validate: Check if string is valid JSON

Limits and errors: a document nested more than 512 levels deep (arrays and objects counted together) is refused by every operation with an error instead of being read or written, because pretty-printing recurses once per level. A query path must be read completely: an empty segment (a..b, a.), an index that is not a non-negative whole number (a[x], a[-1]), or any other text the path syntax does not cover is an error naming the text it stopped at, and an array index too large for an Int is an error naming the index.

Attributes

Example 
import org.llm4s.toolapi.builtin.core.JSONTool
val tools = new ToolRegistry(Seq(JSONTool.tool))
agent.run("Parse this JSON and extract the user's email", tools)
Supertypes
class Object
trait Matchable
class Any
Self type
JSONTool.type
case class UUIDResult(uuid: String, version: Int, variant: String)

Result from UUID generation.

Result from UUID generation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UUIDResult

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
UUIDResult.type
object UUIDTool

Tool for generating UUIDs.

Tool for generating UUIDs.

Generates standard UUID v4 (random) identifiers.

Attributes

Example 
import org.llm4s.toolapi.builtin.core.UUIDTool
val tools = new ToolRegistry(Seq(UUIDTool.tool))
agent.run("Generate a unique ID for this transaction", tools)
Supertypes
class Object
trait Matchable
class Any
Self type
UUIDTool.type

Value members

Concrete fields

val allToolsSafe: Result[Seq[ToolFunction[_, _]]]

All core utility tools combined into a sequence, returning a Result for safe error handling.

All core utility tools combined into a sequence, returning a Result for safe error handling.

Attributes

Generated with