Module: Riffer::Tools::Toolable

Included in:
Riffer::Tool
Defined in:
lib/riffer/tools/toolable.rb

Overview

Shared class-level DSL for anything that presents as a tool to an LLM. Extend it to make a class discoverable as a tool; instance-level execution (call, call_with_validation) lives on Riffer::Tool instead.

class MyTool
  extend Riffer::Tools::Toolable

  description "Does something useful"

  params do
    required :input, String
  end
end

Constant Summary collapse

DEFAULT_TIMEOUT = 
10

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.all ⇒ Object

Returns all classes that have extended Toolable.

– : () -> Array



41
42
43
 
# File 'lib/riffer/tools/toolable.rb', line 41

def self.all
  @extenders || []
end

.extended(base) ⇒ Object

Tracks all classes that extend Toolable.

– : (Module) -> void



32
33
34
35
 
# File 'lib/riffer/tools/toolable.rb', line 32

def self.extended(base)
  extenders = (@extenders ||= []) #: Array[Module]
  extenders << base
end

Instance Method Details

#description(value = nil) ⇒ Object

Gets or sets the tool description.

– : (?String?) -> String?



49
50
51
52
 
# File 'lib/riffer/tools/toolable.rb', line 49

def description(value = nil)
  return @description if value.nil?
  @description = value.to_s
end

#identifier(value = nil) ⇒ Object

Gets or sets the tool identifier/name.

– : (?String?) -> String



58
59
60
61
 
# File 'lib/riffer/tools/toolable.rb', line 58

def identifier(value = nil)
  return @identifier || Riffer::Helpers::ClassNameConverter.convert(Module.instance_method(:name).bind_call(self)) if value.nil?
  @identifier = value.to_s
end

#kind(value = nil) ⇒ Object

Returns the kind of toolable entity; defaults to :tool. – : (?Symbol?) -> Symbol



103
104
105
106
 
# File 'lib/riffer/tools/toolable.rb', line 103

def kind(value = nil)
  return @kind || :tool if value.nil?
  @kind = value.to_sym
end

#name(value = nil) ⇒ Object

Alias for identifier — used by providers.

– : (?String?) -> String



67
68
69
70
 
# File 'lib/riffer/tools/toolable.rb', line 67

def name(value = nil)
  return identifier(value) unless value.nil?
  identifier
end

#parameters_schema(strict: false) ⇒ Object

Returns the JSON Schema for the tool’s parameters.

– : (?strict: bool) -> Hash[Symbol, untyped]



96
97
98
 
# File 'lib/riffer/tools/toolable.rb', line 96

def parameters_schema(strict: false)
  @params_builder&.to_json_schema(strict: strict) || empty_schema
end

#params(&block) ⇒ Object

Defines parameters using the Params DSL.

– : () ?{ (Riffer::Params) [self: Riffer::Params] -> void } -> Riffer::Params?



85
86
87
88
89
90
 
# File 'lib/riffer/tools/toolable.rb', line 85

def params(&block)
  return @params_builder if block.nil?
  builder = Riffer::Params.new
  builder.instance_eval(&block)
  @params_builder = builder
end

#timeout(value = nil) ⇒ Object

Gets or sets the tool timeout in seconds.

– : (?(Integer | Float)?) -> (Integer | Float)



76
77
78
79
 
# File 'lib/riffer/tools/toolable.rb', line 76

def timeout(value = nil)
  return @timeout || DEFAULT_TIMEOUT if value.nil?
  @timeout = value.to_f
end

#to_tool_schema(strict: false) ⇒ Object

Returns a provider-agnostic tool schema hash.

– : (?strict: bool) -> Hash[Symbol, untyped]



112
113
114
115
116
117
118
 
# File 'lib/riffer/tools/toolable.rb', line 112

def to_tool_schema(strict: false)
  {
    name: name,
    description: description,
    parameters_schema: parameters_schema(strict: strict)
  }
end

#validate_as_tool! ⇒ Object

Validates that the minimum required metadata is present for LLM tool use.

Raises Riffer::ArgumentError if validation fails.

– : () -> true

Raises:



126
127
128
129
130
 
# File 'lib/riffer/tools/toolable.rb', line 126

def validate_as_tool!
  raise Riffer::ArgumentError, "#{self} must define a description" if description.nil? || description.to_s.strip.empty?
  raise Riffer::ArgumentError, "#{self} must have an identifier" if identifier.nil? || identifier.to_s.strip.empty?
  true
end