scout-ai 1.1.0 → 1.1.2

data/lib/scout/llm/mcp.rb

@@ -6,7 +6,7 @@ module Workflow
     tasks = self.tasks.keys if tasks.empty?
 
     tools = tasks.collect do |task,inputs=nil|
-      tool_definition = LLM.task_tool_definition(self, task, inputs)[:function]
+      tool_definition = LLM.task_tool_definition(self, task, inputs)
       description = tool_definition[:description]
       input_schema = tool_definition[:parameters].slice(:properties, :required)
       annotations = tool_definition.slice(:title)

data/lib/scout/llm/tools/call.rb

@@ -1,4 +1,7 @@
 module LLM
+  @max_content_length = Scout::Config.get(:max_content_length, :llm_tools, :tools, :llm, :ask, default: 5_000)
+  self.singleton_class.attr_accessor :max_content_length
+
   def self.call_id_name_and_arguments(tool_call)
     tool_call_id = tool_call.dig("call_id") || tool_call.dig("id")
     if tool_call['function']
@@ -15,6 +18,7 @@ module LLM
   end
 
   def self.process_calls(tools, calls, &block)
+    max_content_length = LLM.max_content_length
     IndiferentHash.setup tools
     calls.collect do |tool_call|
       tool_call_id, function_name, function_arguments = call_id_name_and_arguments(tool_call)
@@ -54,10 +58,17 @@ module LLM
                 else
                   function_response.to_json
                 end
+
       content = content.to_s if Numeric === content
 
       Log.high "Called #{function_name}: " + Log.fingerprint(content)
 
+      if content.length > max_content_length
+        exception_msg = "Function #{function_name} called with parameters #{Log.fingerprint function_arguments} returned #{content.length} characters, which is more than the maximum set of #{max_content_length}."
+        Log.high exception_msg
+        content = {exception: exception_msg, stack: caller}.to_json
+      end
+
       response_message = {
         id: tool_call_id,
         role: "tool",

data/lib/scout/llm/tools/mcp.rb

@@ -3,6 +3,10 @@ require 'mcp_client'
 
 module LLM
   def self.mcp_tools(url, options = {})
+    timeout = Scout::Config.get :timeout, :mcp, :tools
+
+    options = IndiferentHash.add_defaults options, read_timeout: timeout.to_i if timeout && timeout != ""
+
     if url == 'stdio'
       client = MCPClient.create_client(mcp_server_configs: [options.merge(type: 'stdio')])
     else

data/lib/scout/llm/tools/workflow.rb

@@ -97,7 +97,9 @@ module LLM
         raise ScoutException, 'Potential recursive call' if parameters[:allow_recursive] != 'true' &&
           (job.running? and job.info[:pid] == Process.pid)
 
-        job.run
+        Workflow.produce(job)
+        job.join
+        job.load
       end
     rescue ScoutException
       return $!

data/lib/scout/llm/utils.rb

@@ -1,21 +1,4 @@
 module LLM
-
-  def self.tag(tag, content, name = nil)
-    if name
-      <<-EOF.strip
-<#{tag} name="#{name}">
-#{content}
-</#{tag}>
-      EOF
-    else
-      <<-EOF.strip
-<#{tag}>
-#{content}
-</#{tag}>
-      EOF
-    end
-  end
-
   def self.get_url_server_tokens(url, prefix=nil)
     return get_url_server_tokens(url).collect{|e| prefix.to_s + "." + e } if prefix
 
@@ -39,4 +22,6 @@ module LLM
     end
     Scout::Config.get(key, *all_tokens, hash)
   end
+
+
 end

data/scout-ai.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: scout-ai 1.1.0 ruby lib
+# stub: scout-ai 1.1.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "scout-ai".freeze
-  s.version = "1.1.0".freeze
+  s.version = "1.1.2".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -49,9 +49,15 @@ Gem::Specification.new do |s|
     "lib/scout/llm/backends/relay.rb",
     "lib/scout/llm/backends/responses.rb",
     "lib/scout/llm/chat.rb",
+    "lib/scout/llm/chat/annotation.rb",
+    "lib/scout/llm/chat/parse.rb",
+    "lib/scout/llm/chat/process.rb",
+    "lib/scout/llm/chat/process/clear.rb",
+    "lib/scout/llm/chat/process/files.rb",
+    "lib/scout/llm/chat/process/options.rb",
+    "lib/scout/llm/chat/process/tools.rb",
     "lib/scout/llm/embed.rb",
     "lib/scout/llm/mcp.rb",
-    "lib/scout/llm/parse.rb",
     "lib/scout/llm/rag.rb",
     "lib/scout/llm/tools.rb",
     "lib/scout/llm/tools/call.rb",
@@ -105,6 +111,8 @@ Gem::Specification.new do |s|
     "test/scout/llm/backends/test_openwebui.rb",
     "test/scout/llm/backends/test_relay.rb",
     "test/scout/llm/backends/test_responses.rb",
+    "test/scout/llm/chat/test_parse.rb",
+    "test/scout/llm/chat/test_process.rb",
     "test/scout/llm/test_agent.rb",
     "test/scout/llm/test_ask.rb",
     "test/scout/llm/test_chat.rb",
@@ -138,6 +146,8 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency(%q<scout-rig>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<ruby-openai>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<ollama-ai>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<ruby-mcp-client>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<hnswlib>.freeze, [">= 0".freeze])
 end
 

data/scout_commands/llm/ask

@@ -21,7 +21,8 @@ characters '???', if they are present.
 -h--help Print this help
 -t--template* Use a template
 -c--chat* Follow a conversation
--i--inline* Ask inline questions about a file
+-i--imports* Chat files to import, separated by comma
+-in--inline* Ask inline questions about a file
 -f--file* Incorporate file at the start
 -m--model* Model to use
 -e--endpoint* Endpoint to use
@@ -39,7 +40,9 @@ end
 
 Log.severity = options.delete(:log).to_i if options.include? :log
 
-file, chat, inline, template, dry_run = IndiferentHash.process_options options, :file, :chat, :inline, :template, :dry_run
+file, chat, inline, imports, template, dry_run = IndiferentHash.process_options options, :file, :chat, :inline, :imports, :template, :dry_run
+
+imports = imports.split(/,\s*/) if imports
 
 question = ARGV * " "
 
@@ -70,7 +73,8 @@ elsif file
 end
 
 if chat
-  conversation = Open.exist?(chat)? LLM.chat(chat) : [] 
+  conversation = Open.exist?(chat)? LLM.chat(chat) : Chat.setup([])
+  imports.each{|import| conversation.import import } if imports
   convo_options = LLM.options conversation
   conversation = question.empty? ? conversation : conversation +  LLM.chat(question)
 
@@ -80,15 +84,15 @@ if chat
   end
 
   new = LLM.ask(conversation, convo_options.merge(options.merge(return_messages: true)))
-  conversation = Open.read(chat) + LLM.print(new)
-  Open.write(chat, conversation)
+  Open.open(chat, mode: 'a'){|f| f.puts LLM.print(new) }
+  puts LLM.purge(new).last[:content]
 elsif inline
 
   file = Open.read inline
 
   new_file = ""
   while true
-    pre, question, post = 
+    pre, question, post =
       file.partition(/^\s*#\s*ask:(?:.*?)(?=^\s*[^\s#]|\z)/smu)
 
       break if question.empty?
@@ -97,10 +101,15 @@ elsif inline
     new_file << question
     clean_question = question.gsub('#', '').gsub(/\s+/,' ').sub(/.*ask:\s*/,'').strip
     chat = [
-      {role: :system, content: "Write a succint reply with no commentary and no formatting."}, 
+      {role: :system, content: "Write a succint reply with no commentary and no formatting."},
       {role: :user, content: "Find the following question as a comment in the file give a response to be placed inline: #{question}"},
       LLM.tag('file', file, inline)
     ]
+
+    chat = Chat.chat(chat)
+
+    imports.each{|import| chat.import import } if imports
+
     response = LLM.ask(LLM.chat(chat))
     new_file << <<-EOF
 # Response start

data/scout_commands/llm/process

@@ -35,10 +35,10 @@ while true
   files = directory.glob('*.json')
 
   files.each do |file|
+    id = File.basename(file, '.json')
     target = directory.reply[id + '.json']
 
     if ! File.exist?(target)
-      id = File.basename(file, '.json')
       options = IndiferentHash.setup(JSON.parse(Open.read(file)))
       question = options.delete(:question)
       reply = LLM.ask(question, options)

data/test/scout/llm/backends/test_anthropic.rb

@@ -2,7 +2,7 @@ require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
 require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
 
 class TestLLMAnthropic < Test::Unit::TestCase
-  def _test_say_hi
+  def test_say_hi
     prompt =<<-EOF
 user: say hi
     EOF
@@ -121,7 +121,7 @@ What is the weather in London. Should I take my umbrella?
     ppp respose
   end
 
-  def test_json_output
+  def _test_json_output
     prompt =<<-EOF
 user:
 

data/test/scout/llm/backends/test_responses.rb

@@ -20,7 +20,7 @@ Some text
     assert(Float === emb.first)
   end
 
-  def test_tool_call_output_weather
+  def _test_tool_call_output_weather
     Log.severity = 0
     prompt =<<-EOF
 function_call:
@@ -38,7 +38,7 @@ should i take an umbrella?
     ppp LLM::Responses.ask prompt, model: 'gpt-4.1-nano'
   end
 
-  def test_tool
+  def _test_tool
     prompt =<<-EOF
 user:
 What is the weather in London. Should I take my umbrella?
@@ -75,7 +75,7 @@ What is the weather in London. Should I take my umbrella?
     ppp respose
   end
 
-  def test_news
+  def _test_news
     prompt =<<-EOF
 websearch: true
 
@@ -86,7 +86,7 @@ What was the top new in the US today?
     ppp LLM::Responses.ask prompt
   end
 
-  def test_image
+  def _test_image
     prompt =<<-EOF
 image: #{datafile_test 'cat.jpg'}
 
@@ -98,7 +98,7 @@ What animal is represented in the image?
     ppp LLM::Responses.ask prompt
   end
 
-  def test_json_output
+  def _test_json_output
     prompt =<<-EOF
 system:
 
@@ -112,7 +112,7 @@ What other movies have the protagonists of the original gost busters played on,
     ppp LLM::Responses.ask prompt, format: :json
   end
 
-  def test_json_format
+  def _test_json_format
     prompt =<<-EOF
 user:
 
@@ -130,7 +130,7 @@ Name each actor and the top movie they took part of
     ppp LLM::Responses.ask prompt, format: format
   end
 
-  def test_json_format_list
+  def _test_json_format_list
     prompt =<<-EOF
 user:
 
@@ -148,7 +148,7 @@ Name each actor as keys and the top 3 movies they took part of as values
     ppp LLM::Responses.ask prompt, format: format
   end
 
-  def test_json_format_actor_list
+  def _test_json_format_actor_list
     prompt =<<-EOF
 user:
 
@@ -199,7 +199,7 @@ Name each actor as keys and the top 3 movies they took part of as values
     ppp LLM::Responses.ask prompt, format: schema
   end
 
-  def test_tool_gpt5
+  def _test_tool_gpt5
     prompt =<<-EOF
 user:
 What is the weather in London. Should I take my umbrella?

data/test/scout/llm/chat/test_parse.rb

@@ -0,0 +1,126 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestParse < Test::Unit::TestCase
+  def test_parse_simple_text
+    text = "Hello\nWorld"
+    msgs = Chat.parse(text)
+    assert_equal 1, msgs.size
+    assert_equal 'user', msgs[0][:role]
+    assert_equal "Hello\nWorld", msgs[0][:content]
+  end
+
+  def test_parse_block_and_inline_headers
+    text = <<~TXT
+    assistant:
+    This is a block
+    with lines
+    user: inline reply
+    another line
+    TXT
+
+    msgs = Chat.parse(text)
+
+    # Expect a few messages: initial empty user, assistant block, inline user, and final user block
+    assert_equal 'user', msgs[0][:role]
+    assert_equal '', msgs[0][:content]
+
+    assert_equal 'assistant', msgs[1][:role]
+    assert_equal "This is a block\nwith lines", msgs[1][:content]
+
+    assert_equal 'user', msgs[2][:role]
+    assert_equal 'inline reply', msgs[2][:content]
+
+    assert_equal 'assistant', msgs[3][:role]
+    assert_equal 'another line', msgs[3][:content]
+  end
+
+  def test_parse_code_fence_protection
+    text = <<~TXT
+    assistant:
+    Here is code:
+    ```
+    def foo
+    end
+    ```
+    Done
+    TXT
+
+    msgs = Chat.parse(text)
+    assert_equal 2, msgs.size # initial empty + assistant
+
+    assistant_msg = msgs[1]
+    assert_equal 'assistant', assistant_msg[:role]
+
+    expected = "Here is code:\n```\ndef foo\nend\n```\nDone"
+    assert_equal expected, assistant_msg[:content]
+  end
+
+  def test_parse_xml_protection
+    text = <<~TXT
+    assistant:
+    Before xml
+    <note>
+    This is protected
+    </note>
+    After
+    TXT
+
+    msgs = Chat.parse(text)
+    assistant_msg = msgs.find { |m| m[:role] == 'assistant' }
+    assert assistant_msg
+    assert_equal "Before xml\n<note>\nThis is protected\n</note>\nAfter", assistant_msg[:content]
+  end
+
+  def test_parse_square_brackets_protection
+    text = <<~TXT
+    assistant:
+    Start
+    [[This: has colon
+    and lines]]
+    End
+    TXT
+
+    msgs = Chat.parse(text)
+    assistant_msg = msgs.find { |m| m[:role] == 'assistant' }
+    assert assistant_msg
+    assert_equal "Start\nThis: has colon\nand lines\nEnd", assistant_msg[:content]
+  end
+
+  def test_parse_cmd_output_protection
+    text = <<~TXT
+    assistant:
+    Before
+    shell:-- ls {{{
+    file1
+    shell:-- ls }}}
+    After
+    TXT
+
+    msgs = Chat.parse(text)
+    assistant_msg = msgs.find { |m| m[:role] == 'assistant' }
+    assert assistant_msg
+
+    expected = "Before\n<cmd_output cmd=\"ls\">\nfile1\n</cmd_output>\nAfter"
+    assert_equal expected, assistant_msg[:content]
+  end
+
+  def test_previous_response_id_behavior
+    text = <<~TXT
+    previous_response_id:abc123
+    Some block
+    assistant: Got it
+    TXT
+
+    msgs = Chat.parse(text)
+
+    # Find the previous_response_id message
+    idx = msgs.index { |m| m[:role] == 'previous_response_id' }
+    assert idx, 'previous_response_id message not found'
+    assert_equal 'abc123', msgs[idx][:content]
+
+    # The message after previous_response_id should be a user block containing "Some block"
+    assert_equal 'user', msgs[idx + 1][:role]
+    assert_equal 'Some block', msgs[idx + 1][:content]
+  end
+end

data/test/scout/llm/chat/test_process.rb

@@ -0,0 +1,123 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+require 'scout/llm/chat'
+class TestProcess < Test::Unit::TestCase
+  def setup
+    super
+    @tmp = tmpdir
+  end
+
+  def _test_imports_basic_and_continue_last
+    TmpFile.with_file do |file|
+      Open.write(file, "assistant: hello\nuser: from_import\n")
+
+      messages = [{role: 'import', content: file}]
+      out = Chat.imports(messages)
+
+      # Should have replaced import with the messages from the file
+      roles = out.collect{|m| m[:role]}
+      assert_includes roles, 'assistant'
+      assert_includes roles, 'user'
+
+      # Test continue: only last non-empty message
+      messages = [{role: 'continue', content: file}]
+      out = Chat.imports(messages)
+      assert_equal 1, out.size
+      assert_equal 'user', out[0][:role]
+      assert_equal 'from_import', out[0][:content].strip
+
+      # Test last: should behave similarly but using purge
+      messages = [{role: 'last', content: file}]
+      out = Chat.imports(messages)
+      assert_equal 1, out.size
+    end
+  end
+
+  def _test_files_file_reads_and_tags_content
+    TmpFile.with_file do |tmp|
+      file = File.join(tmp, 'afile.txt')
+      Open.write(file, "SOME_UNIQUE_CONTENT_12345")
+
+      messages = [{role: 'file', content: file}]
+      out = Chat.files(messages)
+
+      assert_equal 1, out.size
+      msg = out[0]
+      assert_equal 'user', msg[:role]
+      # content should include the file content and the filename
+      assert_match /SOME_UNIQUE_CONTENT_12345/, msg[:content]
+      assert_match /afile.txt/, msg[:content]
+    end
+  end
+
+  def _test_options_extracts_and_resets
+    chat = [
+      {role: 'endpoint', content: 'http://api.example'},
+      {role: 'option', content: 'k1 v1'},
+      {role: 'sticky_option', content: 'sk sv'},
+      {role: 'assistant', content: 'ok'},
+      {role: 'option', content: 'k2 v2'},
+      {role: 'user', content: 'do something'}
+    ]
+
+    opts = Chat.options(chat)
+
+    # endpoint should be sticky
+    assert_equal 'http://api.example', opts['endpoint']
+    # sticky_option should be present
+    assert_equal 'sv', opts['sk']
+    # first option k1 should have been cleared after assistant
+    assert_nil opts['k1']
+    # second option should remain
+    assert_equal 'v2', opts['k2']
+
+    # chat should have been replaced and should not include option messages
+    roles = chat.collect{|m| m[:role]}
+    assert_includes roles, 'assistant'
+    assert_includes roles, 'user'
+    assert_not_includes roles, 'option'
+    assert_not_includes roles, 'sticky_option'
+  end
+
+  def test_tasks_creates_jobs_and_calls_workflow_produce
+    # define a minimal workflow class to be resolved by Kernel.const_get
+    klass = Class.new do
+      def self.job(task_name, jobname=nil, options={})
+        # return a simple object with a path that responds to find
+        path = Struct.new(:p) do
+          def find; p; end
+        end
+        job = Struct.new(:path).new(path.new("/tmp/fake_job_#{task_name}"))
+        job
+      end
+    end
+
+    Object.const_set('TestWorkflow', klass)
+
+    produced = nil
+    # stub Workflow.produce to capture
+    orig = Workflow.method(:produce)
+    Workflow.define_singleton_method(:produce) do |jobs|
+      produced = jobs
+    end
+
+    begin
+      messages = [ {role: 'task', content: 'TestWorkflow mytask jobname=jn param=1'} ]
+      out = Chat.tasks(messages)
+
+      # Should have returned a job message pointing to our fake path
+      assert_equal 1, out.size
+      assert_equal 'job', out[0][:role]
+      assert_match /fake_job_mytask/, out[0][:content]
+
+      # produce should have been called with the job
+      assert_not_nil produced
+      assert_equal 1, produced.size
+    ensure
+      # restore original
+      Workflow.define_singleton_method(:produce, orig)
+      Object.send(:remove_const, 'TestWorkflow') rescue nil
+    end
+  end
+end

data/test/scout/llm/test_agent.rb

@@ -1,7 +1,7 @@
 require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
 require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
 
-require 'rbbt-util'
+require 'scout/knowledge_base'
 class TestLLMAgent < Test::Unit::TestCase
   def test_system
     TmpFile.with_dir do |dir|
@@ -15,7 +15,6 @@ class TestLLMAgent < Test::Unit::TestCase
 
       sss 0
       ppp agent.ask "Who is Miguel's brother-in-law. Brother in law is your spouses sibling or your sibling's spouse"
-      #ppp agent.ask "Who is Guille's brother-in-law. Brother in law is your spouses sibling or your sibling's spouse"
     end
   end
 end