swarm_sdk 2.4.2 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0a32d6cd3def4eb9f0df716e7f10076023f8c1efd5442bdd5f6501af95d542
-  data.tar.gz: e243a4b009844dcf19c7e425ff632a9cf19fe8d7d0e9325107c8ef50efb35f8f
+  metadata.gz: 370423fc8b77c4d3cc159123a64795b04bcea24ed6b96090a194329bb1d5af73
+  data.tar.gz: 05fa10de4f50a64e3bdb919fbea65a4e480cf0eb0b054b2c1e32ef6f5a84c65d
 SHA512:
-  metadata.gz: e8493eac228cb132c969476d884c2e2ae3d7008bbceef134c411549545e8c879e6a4aaa75c9c04835555b28193740633163142c2696ba42f6a85d8ea26ed79b3
-  data.tar.gz: 104440a7754b2fa74bc74eade37cf6ea76cbef2b334d0f5eb0f54bb0f1a38091d3c403294baccbf5a74a44c10468dd5fff89f89abe6c7b5cbba06c36b365e6d0
+  metadata.gz: 064afcb3024b9a3006ba398f1237f5b7c189ae307a7603ea744312ec885f8ea307b1e9cb186d0b0a9da6b9908c46711b58a50c849dfdefce089ec82c989e5b26
+  data.tar.gz: eaded0c55ebc089acd20ad14a73a97ae24fe8cd5acf0cc2c557733ac03d224b96291e0717025998b9ba1c703e96465178b1dfab02c563c1d206790729daf3d21

data/lib/swarm_sdk/agent_registry.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module SwarmSDK
+  # Global registry for reusable agent definitions
+  #
+  # AgentRegistry allows declaring agents in separate files that can be
+  # referenced by name in swarm definitions. This promotes code reuse and
+  # separation of concerns - agent definitions can live in dedicated files
+  # while swarm configurations compose them together.
+  #
+  # ## Usage
+  #
+  # Register agents globally (typically in separate files):
+  #
+  #   # agents/backend.rb
+  #   SwarmSDK.agent :backend do
+  #     model "claude-sonnet-4"
+  #     description "Backend API developer"
+  #     system_prompt "You build REST APIs"
+  #     tools :Read, :Edit, :Bash
+  #   end
+  #
+  # Reference registered agents in swarm definitions:
+  #
+  #   # swarm.rb
+  #   SwarmSDK.build do
+  #     name "Dev Team"
+  #     lead :backend
+  #
+  #     agent :backend  # Pulls from registry
+  #   end
+  #
+  # ## Override Support
+  #
+  # Registered agents can be extended with additional configuration:
+  #
+  #   SwarmSDK.build do
+  #     name "Dev Team"
+  #     lead :backend
+  #
+  #     agent :backend do
+  #       # Registry config is applied first, then this block
+  #       tools :CustomTool  # Adds to tools from registry
+  #       delegates_to :database
+  #     end
+  #   end
+  #
+  # @note This registry is not thread-safe. In multi-threaded environments,
+  #   register all agents before spawning threads, or synchronize access
+  #   externally. For typical fiber-based async usage (the default in SwarmSDK),
+  #   this is not a concern.
+  #
+  class AgentRegistry
+    @agents = {}
+
+    class << self
+      # Register an agent definition block
+      #
+      # Stores a configuration block that will be executed when the agent
+      # is referenced in a swarm definition. The block receives an
+      # Agent::Builder context and can use all builder DSL methods.
+      #
+      # @param name [Symbol, String] Agent name (will be symbolized)
+      # @yield Agent configuration block using Agent::Builder DSL
+      # @return [void]
+      # @raise [ArgumentError] If no block is provided
+      # @raise [ArgumentError] If agent with same name is already registered
+      #
+      # @example Register a backend agent
+      #   SwarmSDK::AgentRegistry.register(:backend) do
+      #     model "claude-sonnet-4"
+      #     description "Backend developer"
+      #     tools :Read, :Edit, :Bash
+      #   end
+      #
+      # @example Register with MCP servers
+      #   SwarmSDK::AgentRegistry.register(:filesystem_agent) do
+      #     model "gpt-4"
+      #     description "File manager"
+      #     mcp_server :fs, type: :stdio, command: "npx", args: ["-y", "@modelcontextprotocol/server-filesystem"]
+      #   end
+      def register(name, &block)
+        raise ArgumentError, "Block required for agent registration" unless block_given?
+
+        sym_name = name.to_sym
+        if @agents.key?(sym_name)
+          raise ArgumentError,
+            "Agent '#{sym_name}' is already registered. " \
+              "Use SwarmSDK.clear_agent_registry! to reset, or choose a different name."
+        end
+
+        @agents[sym_name] = block
+      end
+
+      # Retrieve a registered agent block
+      #
+      # @param name [Symbol, String] Agent name
+      # @return [Proc, nil] The registration block or nil if not found
+      #
+      # @example
+      #   block = SwarmSDK::AgentRegistry.get(:backend)
+      #   builder.instance_eval(&block) if block
+      def get(name)
+        @agents[name.to_sym]
+      end
+
+      # Check if an agent is registered
+      #
+      # @param name [Symbol, String] Agent name
+      # @return [Boolean] true if agent is registered
+      #
+      # @example
+      #   if SwarmSDK::AgentRegistry.registered?(:backend)
+      #     puts "Backend agent is available"
+      #   end
+      def registered?(name)
+        @agents.key?(name.to_sym)
+      end
+
+      # List all registered agent names
+      #
+      # @return [Array<Symbol>] Names of all registered agents
+      #
+      # @example
+      #   SwarmSDK::AgentRegistry.names
+      #   # => [:backend, :frontend, :database]
+      def names
+        @agents.keys
+      end
+
+      # Clear all registrations
+      #
+      # Primarily useful for testing to ensure clean state between tests.
+      #
+      # @return [void]
+      #
+      # @example In test setup/teardown
+      #   def teardown
+      #     SwarmSDK::AgentRegistry.clear
+      #   end
+      def clear
+        @agents.clear
+      end
+    end
+  end
+end

data/lib/swarm_sdk/builders/base_builder.rb

@@ -64,11 +64,14 @@ module SwarmSDK
         @swarm_registry_config = builder.registrations
       end
 
-      # Define an agent with fluent API or load from markdown content
+      # Define an agent with fluent API, load from markdown, or reference registry
       #
-      # Supports two forms:
-      # 1. Inline DSL: agent :name do ... end
-      # 2. Markdown content: agent :name, <<~MD ... MD
+      # Supports multiple forms:
+      # 1. Registry lookup: agent :name (pulls from global registry)
+      # 2. Registry + overrides: agent :name do ... end (when registered)
+      # 3. Inline DSL: agent :name do ... end (when not registered)
+      # 4. Markdown content: agent :name, <<~MD ... MD
+      # 5. Markdown + overrides: agent :name, <<~MD do ... end
       #
       # @example Inline DSL
       #   agent :backend do
@@ -77,6 +80,15 @@ module SwarmSDK
       #     tools :Read, :Write
       #   end
       #
+      # @example Registry lookup (agent must be registered with SwarmSDK.agent)
+      #   agent :backend  # Pulls configuration from registry
+      #
+      # @example Registry + overrides
+      #   agent :backend do
+      #     # Base config from registry, then apply overrides
+      #     tools :CustomTool  # Adds to registry-defined tools
+      #   end
+      #
       # @example Markdown content
       #   agent :backend, <<~MD
       #     ---
@@ -87,19 +99,38 @@ module SwarmSDK
       #     You build APIs.
       #   MD
       def agent(name, content = nil, &block)
+        name = name.to_sym
+
         # Case 1: agent :name, <<~MD do ... end (markdown + overrides)
         if content.is_a?(String) && block_given? && markdown_content?(content)
           load_agent_from_markdown_with_overrides(content, name, &block)
+
         # Case 2: agent :name, <<~MD (markdown only)
         elsif content.is_a?(String) && !block_given? && markdown_content?(content)
           load_agent_from_markdown(content, name)
-        # Case 3: agent :name do ... end (inline DSL)
+
+        # Case 3: agent :name (registry lookup only - no content, no block)
+        elsif content.nil? && !block_given?
+          load_agent_from_registry(name)
+
+        # Case 4: agent :name do ... end (with registered agent - registry + overrides)
+        elsif content.nil? && block_given? && AgentRegistry.registered?(name)
+          load_agent_from_registry_with_overrides(name, &block)
+
+        # Case 5: agent :name do ... end (inline DSL - not registered)
         elsif block_given?
           builder = Agent::Builder.new(name)
           builder.instance_eval(&block)
           @agents[name] = builder
+
         else
-          raise ArgumentError, "Invalid agent definition. Use: agent :name { ... } OR agent :name, <<~MD ... MD OR agent :name, <<~MD do ... end"
+          raise ArgumentError,
+            "Invalid agent definition for '#{name}'. Use:\n  " \
+              "agent :#{name} { ... }           # Inline DSL\n  " \
+              "agent :#{name}                   # Registry lookup\n  " \
+              "agent :#{name} { ... }           # Registry + overrides (if registered)\n  " \
+              "agent :#{name}, <<~MD ... MD     # Markdown\n  " \
+              "agent :#{name}, <<~MD do ... end # Markdown + overrides"
         end
       end
 
@@ -138,6 +169,54 @@ module SwarmSDK
         str.start_with?("---") || str.include?("\n---\n")
       end
 
+      # Load an agent from the global registry
+      #
+      # Retrieves the registered agent block and executes it in the context
+      # of a new Agent::Builder.
+      #
+      # @param name [Symbol] Agent name
+      # @return [void]
+      # @raise [ConfigurationError] If agent is not registered
+      #
+      # @example
+      #   load_agent_from_registry(:backend)
+      def load_agent_from_registry(name)
+        registered_proc = AgentRegistry.get(name)
+        unless registered_proc
+          raise ConfigurationError,
+            "Agent '#{name}' not found in registry. " \
+              "Either define inline with `agent :#{name} do ... end` or " \
+              "register globally with `SwarmSDK.agent :#{name} do ... end`"
+        end
+
+        builder = Agent::Builder.new(name)
+        builder.instance_eval(&registered_proc)
+        @agents[name] = builder
+      end
+
+      # Load an agent from the registry with additional overrides
+      #
+      # Applies the registered configuration first, then executes the
+      # override block to customize the agent.
+      #
+      # @param name [Symbol] Agent name
+      # @yield Override block with additional configuration
+      # @return [void]
+      #
+      # @example
+      #   load_agent_from_registry_with_overrides(:backend) do
+      #     tools :CustomTool  # Adds to registry-defined tools
+      #   end
+      def load_agent_from_registry_with_overrides(name, &override_block)
+        registered_proc = AgentRegistry.get(name)
+        # Guaranteed to exist since we checked in the condition
+
+        builder = Agent::Builder.new(name)
+        builder.instance_eval(&registered_proc)  # Base config from registry
+        builder.instance_eval(&override_block)   # Apply overrides
+        @agents[name] = builder
+      end
+
       # Load an agent from markdown content
       #
       # Returns a hash of the agent config (not a Definition yet) so that

data/lib/swarm_sdk/version.rb

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

data/lib/swarm_sdk/workflow/builder.rb

@@ -119,6 +119,9 @@ module SwarmSDK
       #
       # @return [Workflow] Configured workflow instance
       def build_workflow
+        # Resolve any missing agents from global registry before building definitions
+        resolve_missing_agents_from_registry
+
         # Build agent definitions
         agent_definitions = build_agent_definitions
 
@@ -138,6 +141,52 @@ module SwarmSDK
 
         workflow
       end
+
+      # Resolve agents referenced in nodes that aren't defined at workflow level
+      #
+      # For each agent referenced in a node but not defined with `agent :name do ... end`,
+      # checks the global AgentRegistry and loads the agent if found.
+      #
+      # This allows workflows to reference globally registered agents without
+      # explicitly re-declaring them at the workflow level.
+      #
+      # @return [void]
+      # @raise [ConfigurationError] If agent not found in workflow or registry
+      def resolve_missing_agents_from_registry
+        # Collect all agents referenced in nodes
+        referenced_agents = collect_referenced_agents
+
+        # Find agents that aren't defined at workflow level
+        defined_agents = @agents.keys
+        missing_agents = referenced_agents - defined_agents
+
+        # Try to resolve each missing agent from the global registry
+        missing_agents.each do |agent_name|
+          if AgentRegistry.registered?(agent_name)
+            # Load from registry (uses same method as BaseBuilder)
+            load_agent_from_registry(agent_name)
+          else
+            raise ConfigurationError,
+              "Agent '#{agent_name}' referenced in node but not found. " \
+                "Either define at workflow level with `agent :#{agent_name} do ... end` " \
+                "or register globally with `SwarmSDK.agent :#{agent_name} do ... end`"
+          end
+        end
+      end
+
+      # Collect all agent names referenced across all nodes
+      #
+      # Includes both directly referenced agents and delegation targets.
+      #
+      # @return [Array<Symbol>] Unique agent names referenced in nodes
+      def collect_referenced_agents
+        @nodes.values.flat_map do |node_builder|
+          # Collect both direct agents and their delegation targets
+          node_builder.agent_configs.flat_map do |config|
+            [config[:agent]] + Array(config[:delegates_to])
+          end
+        end.uniq
+      end
     end
   end
 end

data/lib/swarm_sdk.rb

@@ -95,6 +95,73 @@ module SwarmSDK
       Config.reset!
     end
 
+    # Register a global agent definition
+    #
+    # Declares an agent configuration that can be referenced by name in any
+    # swarm definition. This allows defining agents in separate files and
+    # composing them into swarms without duplication.
+    #
+    # The registered block uses the Agent::Builder DSL and is executed when
+    # the agent is referenced in a swarm definition.
+    #
+    # @param name [Symbol, String] Agent name (will be symbolized)
+    # @yield Agent configuration block using Agent::Builder DSL
+    # @return [void]
+    # @raise [ArgumentError] If no block is provided
+    #
+    # @example Register agent in separate file
+    #   # agents/backend.rb
+    #   SwarmSDK.agent :backend do
+    #     model "claude-sonnet-4"
+    #     description "Backend API developer"
+    #     system_prompt "You build REST APIs"
+    #     tools :Read, :Edit, :Bash
+    #     delegates_to :database
+    #   end
+    #
+    # @example Reference in swarm definition
+    #   # swarm.rb
+    #   require_relative "agents/backend"
+    #
+    #   SwarmSDK.build do
+    #     name "Dev Team"
+    #     lead :backend
+    #
+    #     agent :backend  # Pulls from registry
+    #   end
+    #
+    # @example Extend registered agent with overrides
+    #   SwarmSDK.build do
+    #     name "Extended Team"
+    #     lead :backend
+    #
+    #     agent :backend do
+    #       # Registry config applied first, then this block
+    #       tools :CustomTool    # Adds to existing tools
+    #       delegates_to :cache  # Adds delegation target
+    #     end
+    #   end
+    #
+    # @see AgentRegistry
+    def agent(name, &block)
+      AgentRegistry.register(name, &block)
+    end
+
+    # Clear the global agent registry
+    #
+    # Removes all registered agent definitions. Primarily useful for testing
+    # to ensure clean state between tests.
+    #
+    # @return [void]
+    #
+    # @example In test teardown
+    #   def teardown
+    #     SwarmSDK.clear_agent_registry!
+    #   end
+    def clear_agent_registry!
+      AgentRegistry.clear
+    end
+
     # Main entry point for DSL - builds simple multi-agent swarms
     #
     # @return [Swarm] Always returns a Swarm instance

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swarm_sdk
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.4.3
 platform: ruby
 authors:
 - Paulo Arruda
@@ -139,6 +139,7 @@ files:
 - lib/swarm_sdk/agent/definition.rb
 - lib/swarm_sdk/agent/llm_instrumentation_middleware.rb
 - lib/swarm_sdk/agent/system_prompt_builder.rb
+- lib/swarm_sdk/agent_registry.rb
 - lib/swarm_sdk/builders/base_builder.rb
 - lib/swarm_sdk/claude_code_agent_adapter.rb
 - lib/swarm_sdk/concerns/cleanupable.rb