rcrewai 0.2.1 → 0.3.0

data/examples/human_in_the_loop_example.rb

@@ -1,39 +1,40 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../lib/rcrewai'
 
-puts "🤝 Human-in-the-Loop Example"
-puts "=" * 50
+puts '🤝 Human-in-the-Loop Example'
+puts '=' * 50
 
 # Configure RCrewAI
 RCrewAI.configure do |config|
-  config.llm_provider = :openai  # Change as needed
+  config.llm_provider = :openai # Change as needed
   config.temperature = 0.1
 end
 
-puts "🔧 Setting up crew with human interaction capabilities..."
+puts '🔧 Setting up crew with human interaction capabilities...'
 
 # Create crew
-crew = RCrewAI::Crew.new("human_assisted_crew")
+crew = RCrewAI::Crew.new('human_assisted_crew')
 
 # Create agents with human input capabilities
 research_agent = RCrewAI::Agent.new(
-  name: "research_assistant",
-  role: "Research Specialist", 
-  goal: "Conduct thorough research with human oversight",
-  backstory: "You work closely with humans to ensure research quality and accuracy.",
+  name: 'research_assistant',
+  role: 'Research Specialist',
+  goal: 'Conduct thorough research with human oversight',
+  backstory: 'You work closely with humans to ensure research quality and accuracy.',
   tools: [RCrewAI::Tools::WebSearch.new, RCrewAI::Tools::FileWriter.new],
   verbose: true,
-  human_input: true,  # Enable human input
-  require_approval_for_tools: true,  # Require approval for tool usage
-  require_approval_for_final_answer: true  # Require approval for final answers
+  human_input: true, # Enable human input
+  require_approval_for_tools: true, # Require approval for tool usage
+  require_approval_for_final_answer: true # Require approval for final answers
 )
 
 content_creator = RCrewAI::Agent.new(
-  name: "content_creator",
-  role: "Content Writer",
-  goal: "Create engaging content with human guidance",
-  backstory: "You collaborate with humans to create compelling, accurate content.",
+  name: 'content_creator',
+  role: 'Content Writer',
+  goal: 'Create engaging content with human guidance',
+  backstory: 'You collaborate with humans to create compelling, accurate content.',
   tools: [RCrewAI::Tools::FileWriter.new, RCrewAI::Tools::FileReader.new],
   verbose: true,
   human_input: true,
@@ -41,10 +42,10 @@ content_creator = RCrewAI::Agent.new(
 )
 
 quality_checker = RCrewAI::Agent.new(
-  name: "quality_checker", 
-  role: "Quality Assurance Specialist",
-  goal: "Ensure content meets quality standards",
-  backstory: "You work with humans to maintain high quality standards.",
+  name: 'quality_checker',
+  role: 'Quality Assurance Specialist',
+  goal: 'Ensure content meets quality standards',
+  backstory: 'You work with humans to maintain high quality standards.',
   tools: [RCrewAI::Tools::FileReader.new],
   verbose: true,
   human_input: true
@@ -61,22 +62,22 @@ puts "👥 Created crew with #{crew.agents.length} agents (all human-enabled)"
 
 # Task 1: Research with human confirmation and guidance
 research_task = RCrewAI::Task.new(
-  name: "research_ai_trends",
-  description: "Research the latest AI trends for 2024, focusing on practical business applications",
+  name: 'research_ai_trends',
+  description: 'Research the latest AI trends for 2024, focusing on practical business applications',
   agent: research_agent,
-  expected_output: "Comprehensive research document saved as ai_trends_2024.md",
+  expected_output: 'Comprehensive research document saved as ai_trends_2024.md',
   human_input: true,
   require_confirmation: true,  # Human must confirm before starting
   allow_guidance: true,        # Allow human to provide guidance during execution
-  human_review_points: [:completion]  # Review when completed
+  human_review_points: [:completion] # Review when completed
 )
 
 # Task 2: Content creation with human oversight
 content_task = RCrewAI::Task.new(
-  name: "create_ai_article",
-  description: "Write an engaging article based on the research findings about AI trends",
+  name: 'create_ai_article',
+  description: 'Write an engaging article based on the research findings about AI trends',
   agent: content_creator,
-  expected_output: "Well-structured article saved as ai_trends_article.md",
+  expected_output: 'Well-structured article saved as ai_trends_article.md',
   context: [research_task],
   human_input: true,
   allow_guidance: true,
@@ -85,10 +86,10 @@ content_task = RCrewAI::Task.new(
 
 # Task 3: Quality check with human review
 quality_task = RCrewAI::Task.new(
-  name: "quality_review",
-  description: "Review the article for accuracy, clarity, and engagement",
+  name: 'quality_review',
+  description: 'Review the article for accuracy, clarity, and engagement',
   agent: quality_checker,
-  expected_output: "Quality assessment report with recommendations",
+  expected_output: 'Quality assessment report with recommendations',
   context: [content_task],
   human_input: true,
   human_review_points: [:completion]
@@ -102,18 +103,18 @@ puts "📋 Created #{crew.tasks.length} tasks with human interaction points"
 
 # Demonstrate different human interaction modes
 puts "\n🎯 HUMAN-IN-THE-LOOP EXECUTION MODES"
-puts "-" * 40
+puts '-' * 40
 
 puts "\n1️⃣ BASIC HUMAN APPROVAL MODE"
-puts "Tasks will request human approval at key decision points..."
+puts 'Tasks will request human approval at key decision points...'
 
 begin
   results = crew.execute
-  
+
   puts "\n📊 Execution Results:"
   puts "  Completed: #{results[:completed_tasks]}/#{results[:total_tasks]}"
   puts "  Success Rate: #{results[:success_rate]}%"
-  
+
   # Show any generated files
   output_files = ['ai_trends_2024.md', 'ai_trends_article.md']
   puts "\n📄 Generated Files:"
@@ -124,20 +125,19 @@ begin
       puts "  ❌ #{file} (not created)"
     end
   end
-
-rescue => e
+rescue StandardError => e
   puts "❌ Execution failed or was cancelled: #{e.message}"
 end
 
 puts "\n2️⃣ AGENT-LEVEL HUMAN INTERACTION DEMONSTRATION"
-puts "Creating a standalone task to show detailed human interactions..."
+puts 'Creating a standalone task to show detailed human interactions...'
 
 # Create a simple demonstration task
 demo_agent = RCrewAI::Agent.new(
-  name: "demo_agent",
-  role: "Demonstration Agent",
-  goal: "Show human interaction capabilities",
-  backstory: "I demonstrate various human interaction patterns.",
+  name: 'demo_agent',
+  role: 'Demonstration Agent',
+  goal: 'Show human interaction capabilities',
+  backstory: 'I demonstrate various human interaction patterns.',
   tools: [RCrewAI::Tools::FileWriter.new],
   verbose: true
 )
@@ -149,10 +149,10 @@ demo_agent.enable_human_input(
 )
 
 demo_task = RCrewAI::Task.new(
-  name: "human_interaction_demo",
-  description: "Write a short summary of Ruby programming benefits and save it to ruby_benefits.txt",
+  name: 'human_interaction_demo',
+  description: 'Write a short summary of Ruby programming benefits and save it to ruby_benefits.txt',
   agent: demo_agent,
-  expected_output: "A text file containing Ruby programming benefits",
+  expected_output: 'A text file containing Ruby programming benefits',
   human_input: true,
   require_confirmation: true,
   allow_guidance: true
@@ -163,27 +163,26 @@ puts "\n🚀 Starting human interaction demonstration..."
 begin
   demo_result = demo_task.execute
   puts "\nDemo result: #{demo_result}"
-  
+
   if File.exist?('ruby_benefits.txt')
     puts "\n📄 Generated demo file:"
-    puts File.read('ruby_benefits.txt')[0..200] + "..."
+    puts "#{File.read('ruby_benefits.txt')[0..200]}..."
   end
-
-rescue => e
+rescue StandardError => e
   puts "Demo task result: #{e.message}"
 end
 
 puts "\n3️⃣ HUMAN INPUT UTILITY DEMONSTRATION"
-puts "Testing different types of human input requests..."
+puts 'Testing different types of human input requests...'
 
 # Demonstrate the HumanInput utility directly
 human_input = RCrewAI::HumanInput.new(verbose: true)
 
 puts "\nTesting approval request..."
 approval_result = human_input.request_approval(
-  "Test approval request - this is just a demonstration",
-  context: "This is a test of the human input system",
-  consequences: "Nothing will actually happen",
+  'Test approval request - this is just a demonstration',
+  context: 'This is a test of the human input system',
+  consequences: 'Nothing will actually happen',
   timeout: 30
 )
 puts "Approval result: #{approval_result[:approved] ? 'APPROVED' : 'REJECTED'}"
@@ -191,15 +190,15 @@ puts "Approval result: #{approval_result[:approved] ? 'APPROVED' : 'REJECTED'}"
 puts "\nTesting choice request..."
 choice_result = human_input.request_choice(
   "What's your preferred programming language?",
-  ["Ruby", "Python", "JavaScript", "Other"],
+  %w[Ruby Python JavaScript Other],
   timeout: 30
 )
 puts "Choice result: #{choice_result[:choice]}" if choice_result[:valid]
 
 puts "\nTesting input request..."
 input_result = human_input.request_input(
-  "Enter a short message (or press Enter to skip):",
-  help_text: "This is just for testing the input system",
+  'Enter a short message (or press Enter to skip):',
+  help_text: 'This is just for testing the input system',
   timeout: 20
 )
 puts "Input result: '#{input_result[:input]}'" if input_result[:valid]
@@ -210,24 +209,24 @@ summary = human_input.session_summary
 summary.each { |key, value| puts "  #{key}: #{value}" }
 
 puts "\n🎯 HUMAN-IN-THE-LOOP FEATURES DEMONSTRATED:"
-puts "  • Task-level human confirmation before execution"
-puts "  • Agent-level tool approval workflows"
-puts "  • Final answer review and revision capabilities"
-puts "  • Human guidance integration into agent reasoning"
-puts "  • Task completion review and feedback handling"
-puts "  • Error handling with human intervention options"
-puts "  • Flexible human input types (approval, choice, input, review)"
-puts "  • Session tracking and interaction history"
-puts "  • Configurable timeouts and auto-approval modes"
-puts "  • Integration with both sync and async execution"
+puts '  • Task-level human confirmation before execution'
+puts '  • Agent-level tool approval workflows'
+puts '  • Final answer review and revision capabilities'
+puts '  • Human guidance integration into agent reasoning'
+puts '  • Task completion review and feedback handling'
+puts '  • Error handling with human intervention options'
+puts '  • Flexible human input types (approval, choice, input, review)'
+puts '  • Session tracking and interaction history'
+puts '  • Configurable timeouts and auto-approval modes'
+puts '  • Integration with both sync and async execution'
 
 puts "\n💡 USAGE PATTERNS:"
-puts "  1. Development & Testing: Use human approval for tool usage"
-puts "  2. Content Creation: Human review of final outputs"
-puts "  3. Critical Tasks: Human confirmation before execution"
-puts "  4. Learning & Training: Human guidance during reasoning"
-puts "  5. Quality Assurance: Human review at completion points"
-
-puts "\n" + "=" * 50
-puts "🤝 Human-in-the-Loop Demo Complete!"
-puts "=" * 50
+puts '  1. Development & Testing: Use human approval for tool usage'
+puts '  2. Content Creation: Human review of final outputs'
+puts '  3. Critical Tasks: Human confirmation before execution'
+puts '  4. Learning & Training: Human guidance during reasoning'
+puts '  5. Quality Assurance: Human review at completion points'
+
+puts "\n#{'=' * 50}"
+puts '🤝 Human-in-the-Loop Demo Complete!'
+puts '=' * 50

data/examples/mcp_example.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Connect to an MCP server over stdio and expose its tools to an agent.
+#
+# Prerequisites:
+#   # The "filesystem" reference MCP server (Node):
+#   npm install -g @modelcontextprotocol/server-filesystem
+#   # or run it ad-hoc with npx (no global install):
+#   #   command: "npx", args: ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"]
+#
+# Run:
+#   OPENAI_API_KEY=... ruby examples/mcp_example.rb
+
+require_relative '../lib/rcrewai'
+
+RCrewAI.configure do |c|
+  c.llm_provider = :openai
+  c.openai_model = 'gpt-4o-mini'
+end
+
+RCrewAI::MCP::Client.with_connection(
+  command: 'npx',
+  args: ['-y', '@modelcontextprotocol/server-filesystem', '/tmp']
+) do |client|
+  puts "Connected to MCP server: #{client.server_name}"
+  puts 'Available tools:'
+  client.tools.each { |t| puts "  - #{t.name}: #{t.description}" }
+  puts
+
+  agent = RCrewAI::Agent.new(
+    name: 'fs_agent',
+    role: 'Filesystem operator',
+    goal: 'Read and summarize files using the filesystem tools',
+    tools: client.tools
+  )
+
+  task = RCrewAI::Task.new(
+    name: 'list_tmp',
+    description: 'List the files in /tmp and tell me how many there are.',
+    agent: agent,
+    expected_output: 'A short summary'
+  )
+
+  result = agent.execute_task(task)
+  puts "Answer: #{result[:content]}"
+  puts "Tool calls: #{result[:tool_calls_history].length}"
+end

data/examples/native_tools_example.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Native function calling end-to-end.
+#
+# A tool declares a JSON schema via the DSL on Tools::Base. The OpenAI
+# client sends that schema as `tools:` in the request payload, the model
+# replies with a `tool_calls` block, and ToolRunner dispatches the call,
+# threads the result back into the conversation, and continues until the
+# model is done.
+#
+# Run:
+#   OPENAI_API_KEY=... ruby examples/native_tools_example.rb
+
+require_relative '../lib/rcrewai'
+
+# 1. Configure the LLM.
+RCrewAI.configure do |c|
+  c.llm_provider = :openai
+  c.openai_model = 'gpt-4o-mini'
+end
+
+# 2. Declare a tool with the DSL.
+class WeatherTool < RCrewAI::Tools::Base
+  tool_name   'get_weather'
+  description 'Get the current weather for a city'
+  param :city,  type: :string, required: true, description: 'City name'
+  param :units, type: :enum, values: %w[metric imperial], default: 'metric'
+
+  def execute(city:, units: 'metric')
+    # In a real tool this would call a weather API. We fake it for demo.
+    {
+      city: city,
+      temperature: units == 'metric' ? 22 : 72,
+      conditions: 'sunny'
+    }
+  end
+end
+
+# 3. Build an agent that has the tool.
+agent = RCrewAI::Agent.new(
+  name: 'meteorologist',
+  role: 'Helpful weather assistant',
+  goal: 'Answer weather questions accurately',
+  tools: [WeatherTool.new]
+)
+
+# 4. Define and execute a task.
+task = RCrewAI::Task.new(
+  name: 'weather_check',
+  description: "What's the weather in Tokyo?",
+  agent: agent,
+  expected_output: 'A short sentence about the weather'
+)
+
+result = agent.execute_task(task)
+
+puts "Answer:    #{result[:content]}"
+puts 'Tool calls:'
+result[:tool_calls_history].each do |tc|
+  puts "  - #{tc[:tool]}(#{tc[:args]}) -> #{tc[:result]}"
+end
+puts "Tokens:    #{result.dig(:usage, :total_tokens)}"
+puts "Finish:    #{result[:finish_reason]}"

data/examples/streaming_example.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Streaming events from agent.execute_task.
+#
+# Multiple sinks can subscribe to the same stream: one prints tokens as
+# they arrive; another tallies cost from Events::Usage. The sinks are
+# fanned out independently — exceptions in one don't kill the others.
+#
+# Run:
+#   OPENAI_API_KEY=... ruby examples/streaming_example.rb
+
+require_relative '../lib/rcrewai'
+
+RCrewAI.configure do |c|
+  c.llm_provider = :openai
+  c.openai_model = 'gpt-4o-mini'
+end
+
+agent = RCrewAI::Agent.new(
+  name: 'storyteller',
+  role: 'Short-story author',
+  goal: 'Tell concise, vivid stories'
+)
+task = RCrewAI::Task.new(
+  name: 'tell_story',
+  description: 'Tell me a 3-sentence story about a robot and a cat.',
+  agent: agent,
+  expected_output: 'A 3-sentence story'
+)
+
+# Sink 1: print tokens as they arrive.
+printer = lambda do |event|
+  print event.text if event.is_a?(RCrewAI::Events::TextDelta)
+  $stdout.flush
+end
+
+# Sink 2: tally cost and tokens.
+total_cost   = 0.0
+total_tokens = 0
+cost_tracker = lambda do |event|
+  next unless event.is_a?(RCrewAI::Events::Usage)
+
+  total_cost   += event.cost_usd || 0
+  total_tokens += event.total_tokens || 0
+end
+
+# Combine sinks (each event flows to both):
+fan = RCrewAI::Events.fan_out([printer, cost_tracker])
+
+agent.execute_task(task, stream: fan)
+
+puts
+puts '---'
+puts "Total tokens: #{total_tokens}"
+puts "Total cost:   $#{format('%.4f', total_cost)}"