claude_swarm 1.0.1 → 1.0.2

data/lib/swarm_sdk/tools/write.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  module Tools
+    # Write tool for writing content to files
+    #
+    # Creates new files or overwrites existing files.
+    # Enforces read-before-write rule for existing files.
+    # Includes validation and usage guidelines via system reminders.
+    class Write < RubyLLM::Tool
+      include PathResolver
+
+      description <<~DESC
+        Writes a file to the local filesystem.
+        This tool will overwrite the existing file if there is one at the provided path.
+        If this is an existing file, you MUST use the Read tool first to read the file's contents.
+        This tool will fail if you did not read the file first.
+        ALWAYS prefer editing existing files in the codebase. NEVER write new files unless explicitly required.
+        NEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User.
+        Only use emojis if the user explicitly requests it. Avoid writing emojis to files unless asked.
+
+        IMPORTANT - Path Handling:
+        - Relative paths (e.g., "tmp/file.txt", "src/main.rb") are resolved relative to your agent's working directory
+        - Absolute paths (e.g., "/tmp/file.txt", "/etc/passwd") are treated as system absolute paths
+        - When the user says "tmp/file.txt" they mean the tmp directory in your working directory, NOT /tmp
+        - Only use absolute paths (starting with /) when explicitly referring to system-level paths
+      DESC
+
+      param :file_path,
+        type: "string",
+        desc: "Path to the file. Use relative paths (e.g., 'tmp/file.txt') for files in your working directory, or absolute paths (e.g., '/etc/passwd') for system files.",
+        required: true
+
+      param :content,
+        type: "string",
+        desc: "The content to write to the file",
+        required: true
+
+      # Initialize the Write tool for a specific agent
+      #
+      # @param agent_name [Symbol, String] The agent identifier
+      # @param directory [String] Agent's working directory
+      def initialize(agent_name:, directory:)
+        super()
+        @agent_name = agent_name.to_sym
+        @directory = File.expand_path(directory)
+      end
+
+      # Override name to return simple "Write" instead of full class path
+      def name
+        "Write"
+      end
+
+      def execute(file_path:, content:)
+        # Validate inputs
+        return validation_error("file_path is required") if file_path.nil? || file_path.to_s.strip.empty?
+        return validation_error("content is required") if content.nil?
+
+        # CRITICAL: Resolve path against agent directory
+        resolved_path = resolve_path(file_path)
+
+        # Check if file already exists (use resolved path)
+        file_exists = File.exist?(resolved_path)
+
+        # Enforce read-before-write for existing files (use resolved path)
+        if file_exists && !Stores::ReadTracker.file_read?(@agent_name, resolved_path)
+          return validation_error(
+            "Cannot write to existing file without reading it first. " \
+              "You must use the Read tool on '#{file_path}' before overwriting it. " \
+              "This ensures you have context about the file's current contents.",
+          )
+        end
+
+        # Create parent directory if it doesn't exist (use resolved path)
+        parent_dir = File.dirname(resolved_path)
+        FileUtils.mkdir_p(parent_dir) unless File.directory?(parent_dir)
+
+        # Write the file (use resolved path)
+        File.write(resolved_path, content, encoding: "UTF-8")
+
+        # Build success message
+        byte_size = content.bytesize
+        line_count = content.lines.count
+        action = file_exists ? "overwrote" : "created"
+
+        message = "Successfully #{action} file: #{file_path} (#{line_count} lines, #{byte_size} bytes)"
+
+        # Add system reminder for overwritten files
+        if file_exists
+          reminder = "<system-reminder>You overwrote an existing file. Make sure this was intentional and that you read the file first if you needed to preserve any content.</system-reminder>"
+          "#{message}\n\n#{reminder}"
+        else
+          message
+        end
+      rescue Errno::EACCES
+        error("Permission denied: Cannot write to file '#{file_path}'")
+      rescue Errno::EISDIR
+        error("Path is a directory, not a file.")
+      rescue Errno::ENOENT => e
+        error("Failed to create parent directory: #{e.message}")
+      rescue StandardError => e
+        error("Unexpected error writing file: #{e.class.name} - #{e.message}")
+      end
+
+      private
+
+      # Helper methods
+      def validation_error(message)
+        "<tool_use_error>InputValidationError: #{message}</tool_use_error>"
+      end
+
+      def error(message)
+        "Error: #{message}"
+      end
+    end
+  end
+end

data/lib/swarm_sdk/utils.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  # Shared utility methods for SwarmSDK
+  module Utils
+    class << self
+      # Recursively convert all hash keys to symbols
+      #
+      # Handles nested hashes and arrays containing hashes.
+      #
+      # @param obj [Object] Object to symbolize (Hash, Array, or other)
+      # @return [Object] Object with symbolized keys (if applicable)
+      #
+      # @example
+      #   Utils.symbolize_keys({ "name" => "test", "config" => { "key" => "value" } })
+      #   # => { name: "test", config: { key: "value" } }
+      def symbolize_keys(obj)
+        case obj
+        when Hash
+          obj.transform_keys(&:to_sym).transform_values { |v| symbolize_keys(v) }
+        when Array
+          obj.map { |item| symbolize_keys(item) }
+        else
+          obj
+        end
+      end
+
+      # Recursively convert all hash keys to strings
+      #
+      # Handles nested hashes and arrays containing hashes.
+      #
+      # @param obj [Object] Object to stringify (Hash, Array, or other)
+      # @return [Object] Object with stringified keys (if applicable)
+      #
+      # @example
+      #   Utils.stringify_keys({ name: "test", config: { key: "value" } })
+      #   # => { "name" => "test", "config" => { "key" => "value" } }
+      def stringify_keys(obj)
+        case obj
+        when Hash
+          obj.transform_keys(&:to_s).transform_values { |v| stringify_keys(v) }
+        when Array
+          obj.map { |item| stringify_keys(item) }
+        else
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/swarm_sdk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  VERSION = "2.1.1"
+end

data/lib/swarm_sdk.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "digest"
+require "English"
+require "erb"
+require "fileutils"
+require "json"
+require "logger"
+require "pathname"
+require "securerandom"
+require "set"
+require "yaml"
+
+require "async"
+require "async/semaphore"
+require "ruby_llm"
+require "ruby_llm/mcp"
+
+require_relative "swarm_sdk/version"
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.new
+loader.push_dir("#{__dir__}/swarm_sdk", namespace: SwarmSDK)
+loader.inflector.inflect(
+  "cli" => "CLI",
+)
+loader.setup
+
+# Load plugin system explicitly (core infrastructure)
+require_relative "swarm_sdk/plugin"
+require_relative "swarm_sdk/plugin_registry"
+
+# Load custom providers explicitly (Zeitwerk doesn't eager load by default)
+require_relative "swarm_sdk/providers/openai_with_responses"
+
+module SwarmSDK
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class AgentNotFoundError < Error; end
+  class CircularDependencyError < Error; end
+  class ToolExecutionError < Error; end
+  class LLMError < Error; end
+  class StateError < Error; end
+
+  class << self
+    # Settings for SwarmSDK (global configuration)
+    attr_accessor :settings
+
+    # Main entry point for DSL
+    def build(&block)
+      Swarm::Builder.build(&block)
+    end
+
+    # Configure SwarmSDK global settings
+    def configure
+      self.settings ||= Settings.new
+      yield(settings)
+    end
+
+    # Reset settings to defaults
+    def reset_settings!
+      self.settings = Settings.new
+    end
+
+    # Alias for backward compatibility
+    alias_method :configuration, :settings
+    alias_method :reset_configuration!, :reset_settings!
+  end
+
+  # Settings class for SwarmSDK global settings (not to be confused with Configuration for YAML loading)
+  class Settings
+    # WebFetch tool LLM processing configuration
+    attr_accessor :webfetch_provider, :webfetch_model, :webfetch_base_url, :webfetch_max_tokens
+
+    def initialize
+      @webfetch_provider = nil
+      @webfetch_model = nil
+      @webfetch_base_url = nil
+      @webfetch_max_tokens = 4096
+    end
+
+    # Check if WebFetch LLM processing is enabled
+    def webfetch_llm_enabled?
+      !@webfetch_provider.nil? && !@webfetch_model.nil?
+    end
+  end
+
+  # Initialize default settings
+  self.settings = Settings.new
+end
+
+# Automatically configure RubyLLM from environment variables
+# This makes SwarmSDK "just work" when users set standard ENV variables
+RubyLLM.configure do |config|
+  # Only set if config not already set (||= handles nil ENV values gracefully)
+
+  # OpenAI
+  config.openai_api_key ||= ENV["OPENAI_API_KEY"]
+  config.openai_api_base ||= ENV["OPENAI_API_BASE"]
+  config.openai_organization_id ||= ENV["OPENAI_ORG_ID"]
+  config.openai_project_id ||= ENV["OPENAI_PROJECT_ID"]
+
+  # Anthropic
+  config.anthropic_api_key ||= ENV["ANTHROPIC_API_KEY"]
+
+  # Google Gemini
+  config.gemini_api_key ||= ENV["GEMINI_API_KEY"]
+
+  # Google Vertex AI (note: vertexai, not vertex_ai)
+  config.vertexai_project_id ||= ENV["GOOGLE_CLOUD_PROJECT"] || ENV["VERTEXAI_PROJECT_ID"]
+  config.vertexai_location ||= ENV["GOOGLE_CLOUD_LOCATION"] || ENV["VERTEXAI_LOCATION"]
+
+  # DeepSeek
+  config.deepseek_api_key ||= ENV["DEEPSEEK_API_KEY"]
+
+  # Mistral
+  config.mistral_api_key ||= ENV["MISTRAL_API_KEY"]
+
+  # Perplexity
+  config.perplexity_api_key ||= ENV["PERPLEXITY_API_KEY"]
+
+  # OpenRouter
+  config.openrouter_api_key ||= ENV["OPENROUTER_API_KEY"]
+
+  # AWS Bedrock
+  config.bedrock_api_key ||= ENV["AWS_ACCESS_KEY_ID"]
+  config.bedrock_secret_key ||= ENV["AWS_SECRET_ACCESS_KEY"]
+  config.bedrock_region ||= ENV["AWS_REGION"]
+  config.bedrock_session_token ||= ENV["AWS_SESSION_TOKEN"]
+
+  # Ollama (local)
+  config.ollama_api_base ||= ENV["OLLAMA_API_BASE"]
+
+  # GPUStack (local)
+  config.gpustack_api_base ||= ENV["GPUSTACK_API_BASE"]
+  config.gpustack_api_key ||= ENV["GPUSTACK_API_KEY"]
+end
+
+# monkey patches
+# ruby_llm/mcp
+# - add `id` when sending "notifications/initialized" message: https://github.com/patvice/ruby_llm-mcp/issues/65
+# - remove `to_sym` on MCP parameter type: https://github.com/patvice/ruby_llm-mcp/issues/62#issuecomment-3421488406
+require "ruby_llm/mcp/notifications/initialize"
+require "ruby_llm/mcp/parameter"
+
+module RubyLLM
+  module MCP
+    module Notifications
+      class Initialize
+        def call
+          @coordinator.request(notification_body, add_id: true, wait_for_response: false)
+        end
+      end
+    end
+  end
+end