claude_swarm 1.0.0 → 1.0.2

data/lib/swarm_sdk/tools/scratchpad/scratchpad_list.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  module Tools
+    module Scratchpad
+      # Tool for listing scratchpad entries
+      #
+      # Shows all entries in the shared scratchpad with their metadata.
+      # All agents in the swarm share the same scratchpad.
+      class ScratchpadList < RubyLLM::Tool
+        define_method(:name) { "ScratchpadList" }
+
+        description <<~DESC
+          List all entries in scratchpad with their metadata.
+          Shows path, title, size, and last updated time for each entry.
+          Use this to discover what's stored in the scratchpad.
+        DESC
+
+        param :prefix,
+          desc: "Optional prefix to filter entries (e.g., 'notes/' to list all entries under notes/)",
+          required: false
+
+        class << self
+          # Create a ScratchpadList tool for a specific scratchpad storage instance
+          #
+          # @param scratchpad_storage [Stores::ScratchpadStorage] Shared scratchpad storage instance
+          # @return [ScratchpadList] Tool instance
+          def create_for_scratchpad(scratchpad_storage)
+            new(scratchpad_storage)
+          end
+        end
+
+        # Initialize with scratchpad storage instance
+        #
+        # @param scratchpad_storage [Stores::ScratchpadStorage] Shared scratchpad storage instance
+        def initialize(scratchpad_storage)
+          super() # Call RubyLLM::Tool's initialize
+          @scratchpad_storage = scratchpad_storage
+        end
+
+        # Execute the tool
+        #
+        # @param prefix [String, nil] Optional prefix to filter entries
+        # @return [String] Formatted list of entries
+        def execute(prefix: nil)
+          entries = scratchpad_storage.list(prefix: prefix)
+
+          if entries.empty?
+            prefix_msg = prefix ? " with prefix '#{prefix}'" : ""
+            return "No entries found in scratchpad#{prefix_msg}"
+          end
+
+          result = []
+          prefix_msg = prefix ? " with prefix '#{prefix}'" : ""
+          result << "Scratchpad entries#{prefix_msg} (#{entries.size} #{entries.size == 1 ? "entry" : "entries"}):"
+          result << ""
+
+          entries.each do |entry|
+            time_str = entry[:updated_at].strftime("%Y-%m-%d %H:%M:%S")
+            result << "  scratchpad://#{entry[:path]}"
+            result << "    Title: #{entry[:title]}"
+            result << "    Size: #{format_bytes(entry[:size])}"
+            result << "    Updated: #{time_str}"
+            result << ""
+          end
+
+          result.join("\n").rstrip
+        rescue ArgumentError => e
+          validation_error(e.message)
+        end
+
+        private
+
+        attr_reader :scratchpad_storage
+
+        def validation_error(message)
+          "<tool_use_error>InputValidationError: #{message}</tool_use_error>"
+        end
+
+        # Format bytes to human-readable size
+        #
+        # @param bytes [Integer] Number of bytes
+        # @return [String] Formatted size
+        def format_bytes(bytes)
+          if bytes >= 1_000_000
+            "#{(bytes.to_f / 1_000_000).round(1)}MB"
+          elsif bytes >= 1_000
+            "#{(bytes.to_f / 1_000).round(1)}KB"
+          else
+            "#{bytes}B"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swarm_sdk/tools/scratchpad/scratchpad_read.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  module Tools
+    module Scratchpad
+      # Tool for reading content from scratchpad storage
+      #
+      # Retrieves content stored by any agent using scratchpad_write.
+      # All agents in the swarm share the same scratchpad.
+      class ScratchpadRead < RubyLLM::Tool
+        define_method(:name) { "ScratchpadRead" }
+
+        description <<~DESC
+          Read content from scratchpad.
+          Use this to retrieve temporary notes, results, or messages stored by any agent.
+          Any agent can read any scratchpad content.
+        DESC
+
+        param :file_path,
+          desc: "Path to read from scratchpad (e.g., 'status', 'result', 'notes/agent_x')",
+          required: true
+
+        class << self
+          # Create a ScratchpadRead tool for a specific scratchpad storage instance
+          #
+          # @param scratchpad_storage [Stores::ScratchpadStorage] Shared scratchpad storage instance
+          # @return [ScratchpadRead] Tool instance
+          def create_for_scratchpad(scratchpad_storage)
+            new(scratchpad_storage)
+          end
+        end
+
+        # Initialize with scratchpad storage instance
+        #
+        # @param scratchpad_storage [Stores::ScratchpadStorage] Shared scratchpad storage instance
+        def initialize(scratchpad_storage)
+          super() # Call RubyLLM::Tool's initialize
+          @scratchpad_storage = scratchpad_storage
+        end
+
+        # Execute the tool
+        #
+        # @param file_path [String] Path to read from
+        # @return [String] Content at the path with line numbers, or error message
+        def execute(file_path:)
+          content = scratchpad_storage.read(file_path: file_path)
+          format_with_line_numbers(content)
+        rescue ArgumentError => e
+          validation_error(e.message)
+        end
+
+        private
+
+        attr_reader :scratchpad_storage
+
+        def validation_error(message)
+          "<tool_use_error>InputValidationError: #{message}</tool_use_error>"
+        end
+
+        # Format content with line numbers (same format as Read tool)
+        #
+        # @param content [String] Content to format
+        # @return [String] Content with line numbers
+        def format_with_line_numbers(content)
+          lines = content.lines
+          output_lines = lines.each_with_index.map do |line, idx|
+            line_number = idx + 1
+            display_line = line.chomp
+            "#{line_number.to_s.rjust(6)}→#{display_line}"
+          end
+          output_lines.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/swarm_sdk/tools/scratchpad/scratchpad_write.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  module Tools
+    module Scratchpad
+      # Tool for writing content to scratchpad storage
+      #
+      # Stores content in volatile, shared storage for temporary communication.
+      # All agents in the swarm share the same scratchpad.
+      # Data is lost when the process ends (not persisted).
+      class ScratchpadWrite < RubyLLM::Tool
+        define_method(:name) { "ScratchpadWrite" }
+
+        description <<~DESC
+          Store content in scratchpad for temporary cross-agent communication.
+          Use this for quick notes, intermediate results, or coordination messages.
+          Any agent can read this content. Data is lost when the swarm ends.
+
+          For persistent storage that survives across sessions, use MemoryWrite instead.
+
+          Choose a simple, descriptive path. Examples: 'status', 'result', 'notes/agent_x'
+        DESC
+
+        param :file_path,
+          desc: "Simple path for the content (e.g., 'status', 'result', 'notes/agent_x')",
+          required: true
+
+        param :content,
+          desc: "Content to store in scratchpad (max 1MB per entry)",
+          required: true
+
+        param :title,
+          desc: "Brief title describing the content",
+          required: true
+
+        class << self
+          # Create a ScratchpadWrite tool for a specific scratchpad storage instance
+          #
+          # @param scratchpad_storage [Stores::ScratchpadStorage] Shared scratchpad storage instance
+          # @return [ScratchpadWrite] Tool instance
+          def create_for_scratchpad(scratchpad_storage)
+            new(scratchpad_storage)
+          end
+        end
+
+        # Initialize with scratchpad storage instance
+        #
+        # @param scratchpad_storage [Stores::ScratchpadStorage] Shared scratchpad storage instance
+        def initialize(scratchpad_storage)
+          super() # Call RubyLLM::Tool's initialize
+          @scratchpad_storage = scratchpad_storage
+        end
+
+        # Execute the tool
+        #
+        # @param file_path [String] Path to store content
+        # @param content [String] Content to store
+        # @param title [String] Brief title
+        # @return [String] Success message with path and size
+        def execute(file_path:, content:, title:)
+          entry = scratchpad_storage.write(file_path: file_path, content: content, title: title)
+          "Stored at scratchpad://#{file_path} (#{format_bytes(entry.size)})"
+        rescue ArgumentError => e
+          validation_error(e.message)
+        end
+
+        private
+
+        attr_reader :scratchpad_storage
+
+        def validation_error(message)
+          "<tool_use_error>InputValidationError: #{message}</tool_use_error>"
+        end
+
+        # Format bytes to human-readable size
+        #
+        # @param bytes [Integer] Number of bytes
+        # @return [String] Formatted size
+        def format_bytes(bytes)
+          if bytes >= 1_000_000
+            "#{(bytes.to_f / 1_000_000).round(1)}MB"
+          elsif bytes >= 1_000
+            "#{(bytes.to_f / 1_000).round(1)}KB"
+          else
+            "#{bytes}B"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swarm_sdk/tools/stores/read_tracker.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  module Tools
+    module Stores
+      # ReadTracker manages read-file tracking for all agents
+      #
+      # This module maintains a global registry of which files each agent has read
+      # during their conversation. This enables enforcement of the "read-before-write"
+      # and "read-before-edit" rules that ensure agents have context before modifying files.
+      #
+      # Each agent maintains an independent set of read files, keyed by agent identifier.
+      module ReadTracker
+        @read_files = {}
+        @mutex = Mutex.new
+
+        class << self
+          # Register that an agent has read a file
+          #
+          # @param agent_id [Symbol] The agent identifier
+          # @param file_path [String] The absolute path to the file
+          def register_read(agent_id, file_path)
+            @mutex.synchronize do
+              @read_files[agent_id] ||= Set.new
+              @read_files[agent_id] << File.expand_path(file_path)
+            end
+          end
+
+          # Check if an agent has read a file
+          #
+          # @param agent_id [Symbol] The agent identifier
+          # @param file_path [String] The absolute path to the file
+          # @return [Boolean] true if the agent has read this file
+          def file_read?(agent_id, file_path)
+            @mutex.synchronize do
+              return false unless @read_files[agent_id]
+
+              @read_files[agent_id].include?(File.expand_path(file_path))
+            end
+          end
+
+          # Clear read history for an agent (useful for testing)
+          #
+          # @param agent_id [Symbol] The agent identifier
+          def clear(agent_id)
+            @mutex.synchronize do
+              @read_files.delete(agent_id)
+            end
+          end
+
+          # Clear all read history (useful for testing)
+          def clear_all
+            @mutex.synchronize do
+              @read_files.clear
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swarm_sdk/tools/stores/scratchpad_storage.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  module Tools
+    module Stores
+      # ScratchpadStorage provides volatile, shared storage
+      #
+      # Features:
+      # - Shared: All agents share the same scratchpad
+      # - Volatile: NEVER persists - all data lost when process ends
+      # - Path-based: Hierarchical organization using file-path-like addresses
+      # - Metadata-rich: Stores content + title + timestamp + size
+      # - Thread-safe: Mutex-protected operations
+      #
+      # Use for temporary, cross-agent communication within a single session.
+      class ScratchpadStorage < Storage
+        # Initialize scratchpad storage (always volatile)
+        def initialize
+          super() # Initialize parent Storage class
+          @entries = {}
+          @total_size = 0
+          @mutex = Mutex.new
+        end
+
+        # Write content to scratchpad
+        #
+        # @param file_path [String] Path to store content
+        # @param content [String] Content to store
+        # @param title [String] Brief title describing the content
+        # @raise [ArgumentError] If size limits are exceeded
+        # @return [Entry] The created entry
+        def write(file_path:, content:, title:)
+          @mutex.synchronize do
+            raise ArgumentError, "file_path is required" if file_path.nil? || file_path.to_s.strip.empty?
+            raise ArgumentError, "content is required" if content.nil?
+            raise ArgumentError, "title is required" if title.nil? || title.to_s.strip.empty?
+
+            content_size = content.bytesize
+
+            # Check entry size limit
+            if content_size > MAX_ENTRY_SIZE
+              raise ArgumentError, "Content exceeds maximum size (#{format_bytes(MAX_ENTRY_SIZE)}). " \
+                "Current: #{format_bytes(content_size)}"
+            end
+
+            # Calculate new total size
+            existing_entry = @entries[file_path]
+            existing_size = existing_entry ? existing_entry.size : 0
+            new_total_size = @total_size - existing_size + content_size
+
+            # Check total size limit
+            if new_total_size > MAX_TOTAL_SIZE
+              raise ArgumentError, "Scratchpad full (#{format_bytes(MAX_TOTAL_SIZE)} limit). " \
+                "Current: #{format_bytes(@total_size)}, " \
+                "Would be: #{format_bytes(new_total_size)}. " \
+                "Clear old entries or use smaller content."
+            end
+
+            # Create entry
+            entry = Entry.new(
+              content: content,
+              title: title,
+              updated_at: Time.now,
+              size: content_size,
+            )
+
+            # Update storage
+            @entries[file_path] = entry
+            @total_size = new_total_size
+
+            entry
+          end
+        end
+
+        # Read content from scratchpad
+        #
+        # @param file_path [String] Path to read from
+        # @raise [ArgumentError] If path not found
+        # @return [String] Content at the path
+        def read(file_path:)
+          raise ArgumentError, "file_path is required" if file_path.nil? || file_path.to_s.strip.empty?
+
+          entry = @entries[file_path]
+          raise ArgumentError, "scratchpad://#{file_path} not found" unless entry
+
+          entry.content
+        end
+
+        # Delete a specific entry
+        #
+        # @param file_path [String] Path to delete
+        # @raise [ArgumentError] If path not found
+        # @return [void]
+        def delete(file_path:)
+          @mutex.synchronize do
+            raise ArgumentError, "file_path is required" if file_path.nil? || file_path.to_s.strip.empty?
+
+            entry = @entries[file_path]
+            raise ArgumentError, "scratchpad://#{file_path} not found" unless entry
+
+            # Update total size
+            @total_size -= entry.size
+
+            # Remove entry
+            @entries.delete(file_path)
+          end
+        end
+
+        # List scratchpad entries, optionally filtered by prefix
+        #
+        # @param prefix [String, nil] Filter by path prefix
+        # @return [Array<Hash>] Array of entry metadata (path, title, size, updated_at)
+        def list(prefix: nil)
+          entries = @entries
+
+          # Filter by prefix if provided
+          if prefix && !prefix.empty?
+            entries = entries.select { |path, _| path.start_with?(prefix) }
+          end
+
+          # Return metadata sorted by path
+          entries.map do |path, entry|
+            {
+              path: path,
+              title: entry.title,
+              size: entry.size,
+              updated_at: entry.updated_at,
+            }
+          end.sort_by { |e| e[:path] }
+        end
+
+        # Search entries by glob pattern
+        #
+        # @param pattern [String] Glob pattern (e.g., "**/*.txt", "parallel/*/task_*")
+        # @return [Array<Hash>] Array of matching entry metadata, sorted by most recent first
+        def glob(pattern:)
+          raise ArgumentError, "pattern is required" if pattern.nil? || pattern.to_s.strip.empty?
+
+          # Convert glob pattern to regex
+          regex = glob_to_regex(pattern)
+
+          # Filter entries by pattern
+          matching_entries = @entries.select { |path, _| regex.match?(path) }
+
+          # Return metadata sorted by most recent first
+          matching_entries.map do |path, entry|
+            {
+              path: path,
+              title: entry.title,
+              size: entry.size,
+              updated_at: entry.updated_at,
+            }
+          end.sort_by { |e| -e[:updated_at].to_f }
+        end
+
+        # Search entry content by pattern
+        #
+        # @param pattern [String] Regular expression pattern to search for
+        # @param case_insensitive [Boolean] Whether to perform case-insensitive search
+        # @param output_mode [String] Output mode: "files_with_matches" (default), "content", or "count"
+        # @return [Array<Hash>, String] Results based on output_mode
+        def grep(pattern:, case_insensitive: false, output_mode: "files_with_matches")
+          raise ArgumentError, "pattern is required" if pattern.nil? || pattern.to_s.strip.empty?
+
+          # Create regex from pattern
+          flags = case_insensitive ? Regexp::IGNORECASE : 0
+          regex = Regexp.new(pattern, flags)
+
+          case output_mode
+          when "files_with_matches"
+            # Return just the paths that match
+            matching_paths = @entries.select { |_path, entry| regex.match?(entry.content) }
+              .map { |path, _| path }
+              .sort
+            matching_paths
+          when "content"
+            # Return paths with matching lines, sorted by most recent first
+            results = []
+            @entries.each do |path, entry|
+              matching_lines = []
+              entry.content.each_line.with_index(1) do |line, line_num|
+                matching_lines << { line_number: line_num, content: line.chomp } if regex.match?(line)
+              end
+              results << { path: path, matches: matching_lines, updated_at: entry.updated_at } unless matching_lines.empty?
+            end
+            results.sort_by { |r| -r[:updated_at].to_f }.map { |r| r.except(:updated_at) }
+          when "count"
+            # Return paths with match counts, sorted by most recent first
+            results = []
+            @entries.each do |path, entry|
+              count = entry.content.scan(regex).size
+              results << { path: path, count: count, updated_at: entry.updated_at } if count > 0
+            end
+            results.sort_by { |r| -r[:updated_at].to_f }.map { |r| r.except(:updated_at) }
+          else
+            raise ArgumentError, "Invalid output_mode: #{output_mode}. Must be 'files_with_matches', 'content', or 'count'"
+          end
+        end
+
+        # Clear all entries
+        #
+        # @return [void]
+        def clear
+          @mutex.synchronize do
+            @entries.clear
+            @total_size = 0
+          end
+        end
+
+        # Get current total size
+        #
+        # @return [Integer] Total size in bytes
+        attr_reader :total_size
+
+        # Get number of entries
+        #
+        # @return [Integer] Number of entries
+        def size
+          @entries.size
+        end
+      end
+    end
+  end
+end

data/lib/swarm_sdk/tools/stores/storage.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  module Tools
+    module Stores
+      # Abstract base class for hierarchical key-value storage with metadata
+      #
+      # Provides session-scoped storage for agents with path-based organization.
+      # Subclasses implement persistence behavior (volatile vs persistent).
+      #
+      # Features:
+      # - Path-based: Hierarchical organization using file-path-like addresses
+      # - Metadata-rich: Stores content + title + timestamp + size
+      # - Search capabilities: Glob patterns and grep-style content search
+      # - Thread-safe: Mutex-protected operations
+      class Storage
+        # Maximum size per entry (1MB)
+        MAX_ENTRY_SIZE = 1_000_000
+
+        # Maximum total storage size (100MB)
+        MAX_TOTAL_SIZE = 100_000_000
+
+        # Represents a single storage entry with metadata
+        Entry = Struct.new(:content, :title, :updated_at, :size, keyword_init: true)
+
+        # Initialize storage
+        #
+        # Subclasses should call super() in their initialize method.
+        # This base implementation does nothing - it exists only to satisfy RuboCop.
+        def initialize
+          # Base class initialization - subclasses implement their own logic
+        end
+
+        # Write content to storage
+        #
+        # @param file_path [String] Path to store content
+        # @param content [String] Content to store
+        # @param title [String] Brief title describing the content
+        # @raise [ArgumentError] If size limits are exceeded
+        # @return [Entry] The created entry
+        def write(file_path:, content:, title:)
+          raise NotImplementedError, "Subclass must implement #write"
+        end
+
+        # Read content from storage
+        #
+        # @param file_path [String] Path to read from
+        # @raise [ArgumentError] If path not found
+        # @return [String] Content at the path
+        def read(file_path:)
+          raise NotImplementedError, "Subclass must implement #read"
+        end
+
+        # Delete a specific entry
+        #
+        # @param file_path [String] Path to delete
+        # @raise [ArgumentError] If path not found
+        # @return [void]
+        def delete(file_path:)
+          raise NotImplementedError, "Subclass must implement #delete"
+        end
+
+        # List entries, optionally filtered by prefix
+        #
+        # @param prefix [String, nil] Filter by path prefix
+        # @return [Array<Hash>] Array of entry metadata (path, title, size, updated_at)
+        def list(prefix: nil)
+          raise NotImplementedError, "Subclass must implement #list"
+        end
+
+        # Search entries by glob pattern
+        #
+        # @param pattern [String] Glob pattern (e.g., "**/*.txt", "parallel/*/task_*")
+        # @return [Array<Hash>] Array of matching entry metadata, sorted by most recent first
+        def glob(pattern:)
+          raise NotImplementedError, "Subclass must implement #glob"
+        end
+
+        # Search entry content by pattern
+        #
+        # @param pattern [String] Regular expression pattern to search for
+        # @param case_insensitive [Boolean] Whether to perform case-insensitive search
+        # @param output_mode [String] Output mode: "files_with_matches" (default), "content", or "count"
+        # @return [Array<Hash>, String] Results based on output_mode
+        def grep(pattern:, case_insensitive: false, output_mode: "files_with_matches")
+          raise NotImplementedError, "Subclass must implement #grep"
+        end
+
+        # Clear all entries
+        #
+        # @return [void]
+        def clear
+          raise NotImplementedError, "Subclass must implement #clear"
+        end
+
+        # Get current total size
+        #
+        # @return [Integer] Total size in bytes
+        def total_size
+          raise NotImplementedError, "Subclass must implement #total_size"
+        end
+
+        # Get number of entries
+        #
+        # @return [Integer] Number of entries
+        def size
+          raise NotImplementedError, "Subclass must implement #size"
+        end
+
+        protected
+
+        # Format bytes to human-readable size
+        #
+        # @param bytes [Integer] Number of bytes
+        # @return [String] Formatted size (e.g., "1.5MB", "500.0KB")
+        def format_bytes(bytes)
+          if bytes >= 1_000_000
+            "#{(bytes.to_f / 1_000_000).round(1)}MB"
+          elsif bytes >= 1_000
+            "#{(bytes.to_f / 1_000).round(1)}KB"
+          else
+            "#{bytes}B"
+          end
+        end
+
+        # Convert glob pattern to regex
+        #
+        # @param pattern [String] Glob pattern
+        # @return [Regexp] Regular expression
+        def glob_to_regex(pattern)
+          # Escape special regex characters except glob wildcards
+          escaped = Regexp.escape(pattern)
+
+          # Convert glob wildcards to regex
+          # ** matches any number of directories (including zero)
+          escaped = escaped.gsub('\*\*', ".*")
+          # * matches anything except directory separator
+          escaped = escaped.gsub('\*', "[^/]*")
+          # ? matches single character except directory separator
+          escaped = escaped.gsub('\?', "[^/]")
+
+          # Anchor to start and end
+          Regexp.new("\\A#{escaped}\\z")
+        end
+      end
+    end
+  end
+end