Module: RCrewAI::ToolSchema

Included in:
RCrewAI::Tools::Base
Defined in:
lib/rcrewai/tool_schema.rb

Constant Summary collapse

TYPE_MAP = 
{
  string: 'string', integer: 'integer', number: 'number',
  boolean: 'boolean', array: 'array', object: 'object', enum: 'string'
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



10
11
12
13
14
 
# File 'lib/rcrewai/tool_schema.rb', line 10

def self.extended(base)
  base.instance_variable_set(:@params, [])
  base.instance_variable_set(:@tool_name, nil)
  base.instance_variable_set(:@description, nil)
end

Instance Method Details

#description(desc = nil) ⇒ Object 



22
23
24
25
26
 
# File 'lib/rcrewai/tool_schema.rb', line 22

def description(desc = nil)
  return @description || '' if desc.nil?

  @description = desc.to_s
end

#json_schema ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/rcrewai/tool_schema.rb', line 41

def json_schema
  props = {}
  required = []
  params.each do |p|
    entry = { type: TYPE_MAP.fetch(p[:type]) }
    entry[:description] = p[:description] if p[:description]
    entry[:default]     = p[:default]     unless p[:default].nil?
    entry[:items]       = stringify_type(p[:items])   if p[:items]
    entry[:enum]        = p[:values]      if p[:type] == :enum
    entry[:properties]  = p[:properties]  if p[:properties]
    props[p[:name]] = entry
    required << p[:name].to_s if p[:required]
  end

  if params.empty?
    warn_once_no_dsl!
    return {
      name: tool_name,
      description: description,
      parameters: { type: 'object', additionalProperties: true }
    }
  end

  {
    name: tool_name,
    description: description,
    parameters: {
      type: 'object',
      properties: props,
      required: required
    }
  }
end

#param(name, type:, required: false, default: nil, description: nil, items: nil, values: nil, properties: nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



28
29
30
31
32
33
34
35
 
# File 'lib/rcrewai/tool_schema.rb', line 28

def param(name, type:, required: false, default: nil, description: nil, # rubocop:disable Metrics/ParameterLists
          items: nil, values: nil, properties: nil)
  @params ||= []
  @params << {
    name: name, type: type, required: required, default: default,
    description: description, items: items, values: values, properties: properties
  }
end

#params ⇒ Object 



37
38
39
 
# File 'lib/rcrewai/tool_schema.rb', line 37

def params
  @params || []
end

#tool_name(name = nil) ⇒ Object 



16
17
18
19
20
 
# File 'lib/rcrewai/tool_schema.rb', line 16

def tool_name(name = nil)
  return @tool_name || name_default if name.nil?

  @tool_name = name.to_s
end