claude_swarm 1.0.6 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. checksums.yaml +4 -4
  2. data/.ruby-version +1 -1
  3. data/CHANGELOG.md +14 -0
  4. data/README.md +336 -1037
  5. data/docs/V1_TO_V2_MIGRATION_GUIDE.md +1120 -0
  6. data/docs/v1/README.md +1195 -0
  7. data/docs/v2/CHANGELOG.swarm_cli.md +22 -0
  8. data/docs/v2/CHANGELOG.swarm_memory.md +20 -0
  9. data/docs/v2/CHANGELOG.swarm_sdk.md +287 -10
  10. data/docs/v2/README.md +32 -6
  11. data/docs/v2/guides/complete-tutorial.md +133 -37
  12. data/docs/v2/guides/composable-swarms.md +1178 -0
  13. data/docs/v2/guides/getting-started.md +42 -1
  14. data/docs/v2/guides/snapshots.md +1498 -0
  15. data/docs/v2/reference/architecture-flow.md +5 -3
  16. data/docs/v2/reference/event_payload_structures.md +249 -12
  17. data/docs/v2/reference/execution-flow.md +1 -1
  18. data/docs/v2/reference/ruby-dsl.md +368 -22
  19. data/docs/v2/reference/yaml.md +314 -63
  20. data/examples/snapshot_demo.rb +119 -0
  21. data/examples/v2/dsl/01_basic.rb +0 -2
  22. data/examples/v2/dsl/02_core_parameters.rb +0 -2
  23. data/examples/v2/dsl/03_capabilities.rb +0 -2
  24. data/examples/v2/dsl/04_llm_parameters.rb +0 -2
  25. data/examples/v2/dsl/05_advanced_flags.rb +0 -3
  26. data/examples/v2/dsl/06_permissions.rb +0 -4
  27. data/examples/v2/dsl/07_mcp_server.rb +0 -2
  28. data/examples/v2/dsl/08_swarm_hooks.rb +0 -2
  29. data/examples/v2/dsl/09_agent_hooks.rb +0 -2
  30. data/examples/v2/dsl/10_all_agents_hooks.rb +0 -3
  31. data/examples/v2/dsl/11_delegation.rb +0 -2
  32. data/examples/v2/dsl/12_complete_integration.rb +2 -6
  33. data/examples/v2/node_context_demo.rb +1 -1
  34. data/examples/v2/node_workflow.rb +2 -4
  35. data/examples/v2/plan_and_execute.rb +157 -0
  36. data/lib/claude_swarm/configuration.rb +28 -4
  37. data/lib/claude_swarm/version.rb +1 -1
  38. data/lib/swarm_cli/formatters/human_formatter.rb +103 -0
  39. data/lib/swarm_cli/interactive_repl.rb +9 -3
  40. data/lib/swarm_cli/version.rb +1 -1
  41. data/lib/swarm_memory/core/storage_read_tracker.rb +51 -14
  42. data/lib/swarm_memory/integration/cli_registration.rb +3 -2
  43. data/lib/swarm_memory/integration/sdk_plugin.rb +11 -5
  44. data/lib/swarm_memory/tools/memory_edit.rb +2 -2
  45. data/lib/swarm_memory/tools/memory_multi_edit.rb +2 -2
  46. data/lib/swarm_memory/tools/memory_read.rb +3 -3
  47. data/lib/swarm_memory/version.rb +1 -1
  48. data/lib/swarm_memory.rb +5 -0
  49. data/lib/swarm_sdk/agent/builder.rb +33 -0
  50. data/lib/swarm_sdk/agent/chat/context_tracker.rb +33 -0
  51. data/lib/swarm_sdk/agent/chat/hook_integration.rb +49 -3
  52. data/lib/swarm_sdk/agent/chat/system_reminder_injector.rb +11 -27
  53. data/lib/swarm_sdk/agent/chat.rb +200 -51
  54. data/lib/swarm_sdk/agent/context.rb +6 -2
  55. data/lib/swarm_sdk/agent/context_manager.rb +6 -0
  56. data/lib/swarm_sdk/agent/definition.rb +14 -2
  57. data/lib/swarm_sdk/agent/llm_instrumentation_middleware.rb +180 -0
  58. data/lib/swarm_sdk/configuration.rb +387 -94
  59. data/lib/swarm_sdk/events_to_messages.rb +181 -0
  60. data/lib/swarm_sdk/log_collector.rb +31 -5
  61. data/lib/swarm_sdk/log_stream.rb +37 -8
  62. data/lib/swarm_sdk/model_aliases.json +4 -1
  63. data/lib/swarm_sdk/node/agent_config.rb +33 -8
  64. data/lib/swarm_sdk/node/builder.rb +39 -18
  65. data/lib/swarm_sdk/node_orchestrator.rb +293 -26
  66. data/lib/swarm_sdk/proc_helpers.rb +53 -0
  67. data/lib/swarm_sdk/providers/openai_with_responses.rb +22 -15
  68. data/lib/swarm_sdk/restore_result.rb +65 -0
  69. data/lib/swarm_sdk/snapshot.rb +156 -0
  70. data/lib/swarm_sdk/snapshot_from_events.rb +386 -0
  71. data/lib/swarm_sdk/state_restorer.rb +491 -0
  72. data/lib/swarm_sdk/state_snapshot.rb +369 -0
  73. data/lib/swarm_sdk/swarm/agent_initializer.rb +360 -55
  74. data/lib/swarm_sdk/swarm/all_agents_builder.rb +28 -1
  75. data/lib/swarm_sdk/swarm/builder.rb +208 -12
  76. data/lib/swarm_sdk/swarm/swarm_registry_builder.rb +67 -0
  77. data/lib/swarm_sdk/swarm/tool_configurator.rb +46 -11
  78. data/lib/swarm_sdk/swarm.rb +338 -42
  79. data/lib/swarm_sdk/swarm_loader.rb +145 -0
  80. data/lib/swarm_sdk/swarm_registry.rb +136 -0
  81. data/lib/swarm_sdk/tools/delegate.rb +92 -7
  82. data/lib/swarm_sdk/tools/read.rb +17 -5
  83. data/lib/swarm_sdk/tools/stores/read_tracker.rb +47 -12
  84. data/lib/swarm_sdk/tools/stores/scratchpad_storage.rb +45 -0
  85. data/lib/swarm_sdk/utils.rb +18 -0
  86. data/lib/swarm_sdk/validation_result.rb +33 -0
  87. data/lib/swarm_sdk/version.rb +1 -1
  88. data/lib/swarm_sdk.rb +40 -8
  89. data/swarm_cli.gemspec +1 -1
  90. data/swarm_memory.gemspec +2 -2
  91. data/swarm_sdk.gemspec +2 -2
  92. metadata +21 -13
  93. data/examples/learning-assistant/assistant.md +0 -7
  94. data/examples/learning-assistant/example-memories/concept-example.md +0 -90
  95. data/examples/learning-assistant/example-memories/experience-example.md +0 -66
  96. data/examples/learning-assistant/example-memories/fact-example.md +0 -76
  97. data/examples/learning-assistant/example-memories/memory-index.md +0 -78
  98. data/examples/learning-assistant/example-memories/skill-example.md +0 -168
  99. data/examples/learning-assistant/learning_assistant.rb +0 -34
  100. data/examples/learning-assistant/learning_assistant.yml +0 -20
  101. data/lib/swarm_sdk/mcp.rb +0 -16
  102. data/llm.v2.txt +0 -13407
  103. /data/docs/v2/guides/{MEMORY_DEFRAG_GUIDE.md → memory-defrag-guide.md} +0 -0
  104. /data/{llms.txt → llms.claude-swarm.txt} +0 -0
@@ -33,15 +33,19 @@ module SwarmSDK
33
33
  # Threshold at which automatic compression is triggered
34
34
  COMPRESSION_THRESHOLD = 60
35
35
 
36
- attr_reader :name, :delegation_tools, :metadata, :warning_thresholds_hit
36
+ attr_reader :name, :delegation_tools, :metadata, :warning_thresholds_hit, :swarm_id, :parent_swarm_id
37
37
 
38
38
  # Initialize a new agent context
39
39
  #
40
40
  # @param name [Symbol, String] Agent name
41
+ # @param swarm_id [String] Swarm ID for event tracking
42
+ # @param parent_swarm_id [String, nil] Parent swarm ID (nil for root swarms)
41
43
  # @param delegation_tools [Array<String>] Names of tools that are delegations
42
44
  # @param metadata [Hash] Optional metadata about the agent
43
- def initialize(name:, delegation_tools: [], metadata: {})
45
+ def initialize(name:, swarm_id:, parent_swarm_id: nil, delegation_tools: [], metadata: {})
44
46
  @name = name.to_sym
47
+ @swarm_id = swarm_id
48
+ @parent_swarm_id = parent_swarm_id
45
49
  @delegation_tools = Set.new(delegation_tools.map(&:to_s))
46
50
  @metadata = metadata
47
51
  @delegation_call_ids = Set.new
@@ -18,10 +18,16 @@ module SwarmSDK
18
18
  class ContextManager
19
19
  SYSTEM_REMINDER_REGEX = %r{<system-reminder>.*?</system-reminder>}m
20
20
 
21
+ # Expose compression state for snapshot/restore
22
+ # NOTE: @compression_applied initializes to nil (not false), only set to true when compression runs
23
+ attr_reader :compression_applied
24
+ attr_writer :compression_applied
25
+
21
26
  def initialize
22
27
  # Ephemeral content to append to messages for this turn only
23
28
  # Format: { message_index => [array of reminder strings] }
24
29
  @ephemeral_content = {}
30
+ # NOTE: @compression_applied is NOT initialized here - starts as nil
25
31
  end
26
32
 
27
33
  # Track ephemeral content to append to a specific message
@@ -44,13 +44,21 @@ module SwarmSDK
44
44
  :agent_permissions,
45
45
  :assume_model_exists,
46
46
  :hooks,
47
- :memory
47
+ :memory,
48
+ :shared_across_delegations
48
49
 
49
50
  attr_accessor :bypass_permissions, :max_concurrent_tools
50
51
 
51
52
  def initialize(name, config = {})
52
53
  @name = name.to_sym
53
54
 
55
+ # Validate name doesn't contain '@' (reserved for delegation instances)
56
+ if @name.to_s.include?("@")
57
+ raise ConfigurationError,
58
+ "Agent names cannot contain '@' character (reserved for delegation instance naming). " \
59
+ "Agent: #{@name}"
60
+ end
61
+
54
62
  # BREAKING CHANGE: Hard error for plural form
55
63
  if config[:directories]
56
64
  raise ConfigurationError,
@@ -96,6 +104,9 @@ module SwarmSDK
96
104
  # (memory prompt needs to be appended if memory is enabled)
97
105
  @memory = parse_memory_config(config[:memory])
98
106
 
107
+ # Delegation isolation mode (default: false = isolated instances per delegation)
108
+ @shared_across_delegations = config[:shared_across_delegations] || false
109
+
99
110
  # Build system prompt after directory and memory are set
100
111
  @system_prompt = build_full_system_prompt(config[:system_prompt])
101
112
 
@@ -111,7 +122,7 @@ module SwarmSDK
111
122
  # Inject default write restrictions for security
112
123
  @tools = inject_default_write_permissions(@tools)
113
124
 
114
- @delegates_to = Array(config[:delegates_to] || []).map(&:to_sym)
125
+ @delegates_to = Array(config[:delegates_to] || []).map(&:to_sym).uniq
115
126
  @mcp_servers = Array(config[:mcp_servers] || [])
116
127
 
117
128
  # Parse hooks configuration
@@ -181,6 +192,7 @@ module SwarmSDK
181
192
  assume_model_exists: @assume_model_exists,
182
193
  max_concurrent_tools: @max_concurrent_tools,
183
194
  hooks: @hooks,
195
+ shared_across_delegations: @shared_across_delegations,
184
196
  # Permissions are core SDK functionality (not plugin-specific)
185
197
  default_permissions: @default_permissions,
186
198
  permissions: @agent_permissions,
@@ -0,0 +1,180 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SwarmSDK
4
+ module Agent
5
+ # Faraday middleware for capturing LLM API requests and responses
6
+ #
7
+ # This middleware intercepts HTTP calls to LLM providers and emits
8
+ # structured events via LogStream for logging and monitoring.
9
+ #
10
+ # Events emitted:
11
+ # - llm_api_request: Before sending request to LLM API
12
+ # - llm_api_response: After receiving response from LLM API
13
+ #
14
+ # The middleware is injected at runtime into the provider's Faraday
15
+ # connection stack (see Agent::Chat#inject_llm_instrumentation).
16
+ class LLMInstrumentationMiddleware < Faraday::Middleware
17
+ # Initialize middleware
18
+ #
19
+ # @param app [Faraday::Connection] Faraday app
20
+ # @param on_request [Proc] Callback for request events
21
+ # @param on_response [Proc] Callback for response events
22
+ # @param provider_name [String] Provider name for logging
23
+ def initialize(app, on_request:, on_response:, provider_name:)
24
+ super(app)
25
+ @on_request = on_request
26
+ @on_response = on_response
27
+ @provider_name = provider_name
28
+ end
29
+
30
+ # Intercept HTTP call
31
+ #
32
+ # @param env [Faraday::Env] Request environment
33
+ # @return [Faraday::Response] HTTP response
34
+ def call(env)
35
+ start_time = Time.now
36
+
37
+ # Emit request event
38
+ emit_request_event(env, start_time)
39
+
40
+ # Execute request
41
+ @app.call(env).on_complete do |response_env|
42
+ end_time = Time.now
43
+ duration = end_time - start_time
44
+
45
+ # Emit response event
46
+ emit_response_event(response_env, start_time, end_time, duration)
47
+ end
48
+ end
49
+
50
+ private
51
+
52
+ # Emit request event
53
+ #
54
+ # @param env [Faraday::Env] Request environment
55
+ # @param timestamp [Time] Request timestamp
56
+ # @return [void]
57
+ def emit_request_event(env, timestamp)
58
+ request_data = {
59
+ provider: @provider_name,
60
+ body: parse_body(env.body),
61
+ timestamp: timestamp.utc.iso8601,
62
+ }
63
+
64
+ @on_request.call(request_data)
65
+ rescue StandardError => e
66
+ # Don't let logging errors break the request
67
+ RubyLLM.logger.error("LLM instrumentation request error: #{e.message}")
68
+ end
69
+
70
+ # Emit response event
71
+ #
72
+ # @param env [Faraday::Env] Response environment
73
+ # @param start_time [Time] Request start time
74
+ # @param end_time [Time] Request end time
75
+ # @param duration [Float] Request duration in seconds
76
+ # @return [void]
77
+ def emit_response_event(env, start_time, end_time, duration)
78
+ response_data = {
79
+ provider: @provider_name,
80
+ body: parse_body(env.body),
81
+ duration_seconds: duration.round(3),
82
+ timestamp: end_time.utc.iso8601,
83
+ }
84
+
85
+ # Extract usage information from response body if available
86
+ if env.body.is_a?(String) && !env.body.empty?
87
+ begin
88
+ parsed = JSON.parse(env.body)
89
+ response_data[:usage] = extract_usage(parsed) if parsed.is_a?(Hash)
90
+ response_data[:model] = parsed["model"] if parsed.is_a?(Hash)
91
+ response_data[:finish_reason] = extract_finish_reason(parsed) if parsed.is_a?(Hash)
92
+ rescue JSON::ParserError
93
+ # Not JSON, skip usage extraction
94
+ end
95
+ end
96
+
97
+ @on_response.call(response_data)
98
+ rescue StandardError => e
99
+ # Don't let logging errors break the response
100
+ RubyLLM.logger.error("LLM instrumentation response error: #{e.message}")
101
+ end
102
+
103
+ # Sanitize headers by removing sensitive data
104
+ #
105
+ # @param headers [Hash] HTTP headers
106
+ # @return [Hash] Sanitized headers
107
+ def sanitize_headers(headers)
108
+ return {} unless headers
109
+
110
+ headers.transform_keys(&:to_s).transform_values do |value|
111
+ # Redact authorization headers
112
+ if value.to_s.match?(/bearer|token|key/i)
113
+ "[REDACTED]"
114
+ else
115
+ value.to_s
116
+ end
117
+ end
118
+ rescue StandardError
119
+ {}
120
+ end
121
+
122
+ # Parse request/response body
123
+ #
124
+ # @param body [String, Hash, nil] HTTP body
125
+ # @return [Hash, String, nil] Parsed body
126
+ def parse_body(body)
127
+ return if body.nil? || body == ""
128
+
129
+ # Already parsed
130
+ return body if body.is_a?(Hash)
131
+
132
+ # Try to parse JSON
133
+ JSON.parse(body)
134
+ rescue JSON::ParserError
135
+ # Return truncated string if not JSON
136
+ body.to_s[0..1000]
137
+ rescue StandardError
138
+ nil
139
+ end
140
+
141
+ # Extract usage statistics from response
142
+ #
143
+ # Handles different provider formats (OpenAI, Anthropic, etc.)
144
+ #
145
+ # @param parsed [Hash] Parsed response body
146
+ # @return [Hash, nil] Usage statistics
147
+ def extract_usage(parsed)
148
+ usage = parsed["usage"] || parsed.dig("usage")
149
+ return unless usage
150
+
151
+ {
152
+ input_tokens: usage["input_tokens"] || usage["prompt_tokens"],
153
+ output_tokens: usage["output_tokens"] || usage["completion_tokens"],
154
+ total_tokens: usage["total_tokens"],
155
+ }.compact
156
+ rescue StandardError
157
+ nil
158
+ end
159
+
160
+ # Extract finish reason from response
161
+ #
162
+ # Handles different provider formats
163
+ #
164
+ # @param parsed [Hash] Parsed response body
165
+ # @return [String, nil] Finish reason
166
+ def extract_finish_reason(parsed)
167
+ # Anthropic format
168
+ return parsed["stop_reason"] if parsed["stop_reason"]
169
+
170
+ # OpenAI format
171
+ choices = parsed["choices"]
172
+ return unless choices&.is_a?(Array) && !choices.empty?
173
+
174
+ choices.first["finish_reason"]
175
+ rescue StandardError
176
+ nil
177
+ end
178
+ end
179
+ end
180
+ end