Class: Riffer::Tool

Inherits:
Object
  • Object
show all
Extended by:
Registrable, Riffer::Tools::Toolable
Defined in:
lib/riffer/tool.rb,
sig/manual/riffer/tool.rbs,
sig/generated/riffer/tool.rbs

Overview

Base class for all tools in the Riffer framework. Subclasses must implement the call method.

class WeatherLookupTool < Riffer::Tool
description "Provides current weather information for a specified city."

params do
  required :city, String, description: "The city to look up"
  optional :units, String, default: "celsius"
end

def call(context:, city:, units: nil)
  # Implementation
end
end

Constant Summary

Constants included from Riffer::Tools::Toolable

Riffer::Tools::Toolable::DEFAULT_TIMEOUT

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Riffer::Tools::Toolable

description, extended, identifier, kind, name, parameters_schema, params, timeout, to_tool_schema, validate_as_tool!

Methods included from Registrable

all, find

Class Method Details

.all ⇒ Array[singleton(Riffer::Tool)]

Returns:



6
 
# File 'sig/manual/riffer/tool.rbs', line 6

def self.all: () -> Array[singleton(Riffer::Tool)]

.find ⇒ singleton(Riffer::Tool)?

Parameters:

  • (String, Symbol)

Returns:



4
 
# File 'sig/manual/riffer/tool.rbs', line 4

def self.find: (String | Symbol) -> singleton(Riffer::Tool)?

Instance Method Details

#call(context:, **kwargs) ⇒ Riffer::Tools::Response

Executes the tool with the given arguments.

: (context: Riffer::Agent::Context?, **untyped) -> Riffer::Tools::Response

Parameters:

Returns:



31
32
33
 
# File 'lib/riffer/tool.rb', line 31

def call(context:, **kwargs)
  raise NotImplementedError, "#{self.class} must implement #call"
end

#call_with_validation(context:, **kwargs) ⇒ Riffer::Tools::Response

Executes the tool with validation and timeout (used by Agent).

Raises Riffer::ValidationError if validation fails. Raises Riffer::TimeoutError if execution exceeds the configured timeout. Raises Riffer::Error if the tool does not return a Response object.

-- : (context: Riffer::Agent::Context?, **untyped) -> Riffer::Tools::Response

Parameters:

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/riffer/tool.rb', line 67

def call_with_validation(context:, **kwargs)
  params_builder = self.class.params
  validated_args = params_builder ? params_builder.validate(kwargs) : kwargs

  result = Timeout.timeout(self.class.timeout) do
    call(context: context, **validated_args) #: untyped
  end

  unless result.is_a?(Riffer::Tools::Response)
    raise Riffer::Error, "#{self.class} must return a Riffer::Tools::Response from #call"
  end

  result
rescue Timeout::Error
  raise Riffer::TimeoutError, "Tool execution timed out after #{self.class.timeout} seconds"
end

#error(message, type: :execution_error) ⇒ Riffer::Tools::Response

Creates an error response.

-- : (String, ?type: Symbol) -> Riffer::Tools::Response

Parameters:

  • (String)
  • type: (Symbol) (defaults to: :execution_error)

Returns:



55
56
57
 
# File 'lib/riffer/tool.rb', line 55

def error(message, type: :execution_error)
  Riffer::Tools::Response.error(message, type: type)
end

#json(result) ⇒ Riffer::Tools::Response

Creates a JSON response.

-- : (untyped) -> Riffer::Tools::Response

Parameters:

  • (Object)

Returns:



47
48
49
 
# File 'lib/riffer/tool.rb', line 47

def json(result)
  Riffer::Tools::Response.json(result)
end

#text(result) ⇒ Riffer::Tools::Response

Creates a text response.

-- : (untyped) -> Riffer::Tools::Response

Parameters:

  • (Object)

Returns:



39
40
41
 
# File 'lib/riffer/tool.rb', line 39

def text(result)
  Riffer::Tools::Response.text(result)
end