rails-active-mcp 2.0.7 → 2.0.12

data/lib/rails_active_mcp/sdk/server.rb

@@ -68,7 +68,7 @@ module RailsActiveMcp
 
         # Create log directory
         log_dir = File.join(Dir.pwd, 'log')
-        FileUtils.mkdir_p(log_dir) unless Dir.exist?(log_dir)
+        FileUtils.mkdir_p(log_dir)
 
         # Redirect stderr to log file
         stderr_log = File.join(log_dir, 'rails_mcp_stderr.log')

data/lib/rails_active_mcp/sdk/tools/console_execute_tool.rb

@@ -70,8 +70,6 @@ module RailsActiveMcp
           end
         end
 
-        private
-
         def self.format_success_result(result)
           output = []
           output << "Code: #{result[:code]}"

data/lib/rails_active_mcp/sdk/tools/dry_run_tool.rb

@@ -60,8 +60,6 @@ module RailsActiveMcp
                                   ])
         end
 
-        private
-
         def self.error_response(message)
           MCP::Tool::Response.new([
                                     { type: 'text', text: message }

data/lib/rails_active_mcp/sdk/tools/model_info_tool.rb

@@ -40,7 +40,7 @@ module RailsActiveMcp
 
         def self.call(model:, server_context:, include_schema: true, include_associations: true,
                       include_validations: true)
-          config = RailsActiveMcp.config
+          RailsActiveMcp.config
 
           begin
             model_class = model.constantize
@@ -93,8 +93,6 @@ module RailsActiveMcp
           end
         end
 
-        private
-
         def self.error_response(message)
           MCP::Tool::Response.new([
                                     { type: 'text', text: message }

data/lib/rails_active_mcp/sdk/tools/safe_query_tool.rb

@@ -64,8 +64,6 @@ module RailsActiveMcp
           end
         end
 
-        private
-
         def self.error_response(message)
           MCP::Tool::Response.new([
                                     { type: 'text', text: message }

data/lib/rails_active_mcp/tasks.rake

@@ -1,6 +1,6 @@
 namespace :rails_active_mcp do
-  desc "Check the safety of Ruby code"
-  task :check_safety, [:code] => :environment do |task, args|
+  desc 'Check the safety of Ruby code'
+  task :check_safety, [:code] => :environment do |_task, args|
     code = args[:code]
 
     if code.blank?
@@ -24,8 +24,8 @@ namespace :rails_active_mcp do
     end
   end
 
-  desc "Execute Ruby code with safety checks"
-  task :execute, [:code] => :environment do |task, args|
+  desc 'Execute Ruby code with safety checks'
+  task :execute, [:code] => :environment do |_task, args|
     code = args[:code]
 
     if code.blank?
@@ -44,111 +44,267 @@ namespace :rails_active_mcp do
         puts "Error: #{result[:error]}"
         puts "Error class: #{result[:error_class]}" if result[:error_class]
       end
-    rescue => e
+    rescue StandardError => e
       puts "Failed to execute: #{e.message}"
       exit 1
     end
   end
 
-  desc "Test MCP tools"
-  task :test_tools => :environment do
-    puts "Testing Rails Active MCP tools..."
+  desc 'Test MCP tools'
+  task test_tools: :environment do
+    puts 'Testing Rails Active MCP tools...'
 
-    # Test SafeQueryTool
-    puts "\n1. Testing SafeQueryTool..."
-    if defined?(User)
-      tool = RailsActiveMcp::Tools::SafeQueryTool.new
-      result = tool.call(model: "User", method: "count")
-      puts "  User.count: #{result[:success] ? result[:result] : result[:error]}"
+    # Test console execution
+    puts "\n1. Testing console_execute tool:"
+    result = RailsActiveMcp.execute('1 + 1')
+    puts "  Simple math: #{result[:success] ? 'PASS' : 'FAIL'}"
+
+    # Test safety checking
+    puts "\n2. Testing safety checking:"
+    safe_result = RailsActiveMcp.safe?('User.count')
+    dangerous_result = RailsActiveMcp.safe?('User.delete_all')
+    puts "  Safe code detection: #{safe_result ? 'PASS' : 'FAIL'}"
+    puts "  Dangerous code detection: #{dangerous_result ? 'FAIL' : 'PASS'}"
+
+    # Test Rails integration
+    puts "\n3. Testing Rails integration:"
+    if defined?(Rails) && Rails.respond_to?(:env)
+      puts "  Rails environment: #{Rails.env} - PASS"
     else
-      puts "  Skipped (User model not found)"
+      puts '  Rails environment: NOT DETECTED - FAIL'
     end
 
-    # Test ConsoleExecuteTool
-    puts "\n2. Testing ConsoleExecuteTool..."
-    tool = RailsActiveMcp::Tools::ConsoleExecuteTool.new
-    result = tool.call(code: "1 + 1")
-    puts "  1 + 1: #{result[:success] ? result[:return_value] : result[:error]}"
+    puts "\nAll tests completed!"
+  end
 
-    # Test DryRunTool
-    puts "\n3. Testing DryRunTool..."
-    tool = RailsActiveMcp::Tools::DryRunTool.new
-    result = tool.call(code: "User.delete_all")
-    puts "  User.delete_all analysis: #{result[:estimated_risk]} risk"
+  desc 'Benchmark MCP tools performance'
+  task benchmark: :environment do
+    require 'benchmark'
 
-    puts "\nAll tools tested!"
-  end
+    puts 'Rails Active MCP Performance Benchmark'
+    puts '=' * 50
 
-  desc "Show configuration"
-  task :config => :environment do
-    config = RailsActiveMcp.config
+    # Benchmark safety checking
+    puts "\nSafety Checker Performance:"
+    Benchmark.bm(20) do |x|
+      x.report('Simple check:') do
+        1000.times { RailsActiveMcp.safe?('User.count') }
+      end
 
-    puts "Rails Active MCP Configuration:"
-    puts "  Enabled: #{config.enabled}"
-    puts "  Safe mode: #{config.safe_mode}"
-    puts "  Default timeout: #{config.default_timeout}s"
-    puts "  Max results: #{config.max_results}"
-    puts "  Log executions: #{config.log_executions}"
-    puts "  Audit file: #{config.audit_file}"
-    puts "  Enable mutation tools: #{config.enable_mutation_tools}"
-    puts "  Execution environment: #{config.execution_environment}"
+      x.report('Complex check:') do
+        100.times { RailsActiveMcp.safe?('User.where(active: true).includes(:posts).limit(10)') }
+      end
 
-    if config.allowed_models.any?
-      puts "  Allowed models: #{config.allowed_models.join(', ')}"
+      x.report('Dangerous check:') do
+        1000.times { RailsActiveMcp.safe?('User.delete_all') }
+      end
     end
 
-    if config.blocked_models.any?
-      puts "  Blocked models: #{config.blocked_models.join(', ')}"
-    end
+    # Benchmark code execution
+    puts "\nCode Execution Performance:"
+    Benchmark.bm(20) do |x|
+      x.report('Simple math:') do
+        100.times { RailsActiveMcp.execute('1 + 1') }
+      end
 
-    if config.custom_safety_patterns.any?
-      puts "  Custom safety patterns: #{config.custom_safety_patterns.size}"
+      x.report('String operations:') do
+        100.times { RailsActiveMcp.execute('"hello".upcase') }
+      end
     end
   end
 
-  desc "View audit log"
-  task :audit_log, [:lines] => :environment do |task, args|
-    lines = args[:lines]&.to_i || 10
-    audit_file = RailsActiveMcp.config.audit_file
+  desc 'Validate Rails Active MCP configuration'
+  task validate_config: :environment do
+    puts 'Validating Rails Active MCP configuration...'
+
+    config = RailsActiveMcp.config
+
+    if config.valid?
+      puts '✅ Configuration is valid'
 
-    unless File.exist?(audit_file)
-      puts "Audit log not found at: #{audit_file}"
+      puts "\nCurrent Settings:"
+      puts "  Safe mode: #{config.safe_mode}"
+      puts "  Command timeout: #{config.command_timeout}s"
+      puts "  Max results: #{config.max_results}"
+      puts "  Log executions: #{config.log_executions}"
+      puts "  Log level: #{config.log_level}"
+      puts "  Allowed models: #{config.allowed_models.any? ? config.allowed_models.join(', ') : 'All models allowed'}"
+      puts "  Custom safety patterns: #{config.custom_safety_patterns.length} patterns"
+    else
+      puts '❌ Configuration is invalid'
+      puts 'Please check your config/initializers/rails_active_mcp.rb file'
       exit 1
     end
+  end
+
+  desc 'Generate example usage documentation'
+  task generate_examples: :environment do
+    examples_file = Rails.root.join('doc/rails_active_mcp_examples.md')
+    FileUtils.mkdir_p(File.dirname(examples_file))
+
+    content = <<~MARKDOWN
+      # Rails Active MCP Usage Examples
+
+      Generated on #{Date.current}
+
+      ## Safe Operations
+
+      These operations are considered safe and can be executed in safe mode:
+
+      ```ruby
+      # Basic model queries
+      User.count
+      User.all.limit(10)
+      User.where(active: true)
+      User.find(1)
+
+      # Associations
+      User.includes(:posts).limit(5)
+      Post.joins(:user).where(users: { active: true })
+
+      # Aggregations
+      Order.sum(:total_amount)
+      User.group(:status).count
+
+      # System information
+      Rails.env
+      Rails.version
+      Time.current
+      ```
+
+      ## Dangerous Operations (Blocked in Safe Mode)
+
+      These operations are blocked when safe_mode is enabled:
 
-    puts "Last #{lines} entries from audit log:"
-    puts "=" * 50
-
-    File.readlines(audit_file).last(lines).each do |line|
-      begin
-        entry = JSON.parse(line)
-        timestamp = entry['timestamp']
-        code = entry['code']
-        user = entry.dig('user', 'email') || entry.dig('user', 'environment') || 'unknown'
-
-        puts "#{timestamp} [#{user}]: #{code}"
-
-        if entry['type'] == 'error'
-          puts "  ERROR: #{entry['error']}"
-        elsif entry['safety_check'] && !entry['safety_check']['safe']
-          puts "  SAFETY: #{entry['safety_check']['summary']}"
-        end
-        puts
-      rescue JSON::ParserError
-        puts "Invalid JSON entry: #{line}"
+      ```ruby
+      # Mass deletions
+      User.delete_all
+      User.destroy_all
+
+      # System commands
+      system('rm -rf /')
+      `ls -la`
+
+      # File operations
+      File.delete('important_file.txt')
+      FileUtils.rm_rf('/important/directory')
+
+      # Code evaluation
+      eval(user_input)
+      send(dynamic_method)
+      ```
+
+      ## Claude Desktop Usage Examples
+
+      Ask Claude these questions to interact with your Rails app:
+
+      - "How many users do we have?"
+      - "Show me the User model structure"
+      - "What are the most recent orders?"
+      - "Check if this code is safe: User.where(active: false).delete_all"
+      - "Find users created in the last week"
+      - "What associations does the Post model have?"
+
+      ## Configuration Examples
+
+      ### Development Configuration
+      ```ruby
+      RailsActiveMcp.configure do |config|
+        config.safe_mode = false
+        config.log_level = :debug
+        config.command_timeout = 60
+        config.max_results = 200
       end
-    end
+      ```
+
+      ### Production Configuration
+      ```ruby
+      RailsActiveMcp.configure do |config|
+        config.safe_mode = true
+        config.log_level = :warn
+        config.command_timeout = 15
+        config.max_results = 50
+        config.allowed_models = %w[User Post Comment]
+      end
+      ```
+    MARKDOWN
+
+    File.write(examples_file, content)
+    puts "Examples generated at: #{examples_file}"
   end
 
-  desc "Clear audit log"
-  task :clear_audit_log => :environment do
-    audit_file = RailsActiveMcp.config.audit_file
+  desc 'Install Claude Desktop configuration'
+  task install_claude_config: :environment do
+    config_template = {
+      mcpServers: {
+        'rails-active-mcp' => {
+          command: Rails.root.join('bin/rails-active-mcp-wrapper').to_s,
+          cwd: Rails.root.to_s,
+          env: {
+            RAILS_ENV: Rails.env
+          }
+        }
+      }
+    }
 
-    if File.exist?(audit_file)
-      File.truncate(audit_file, 0)
-      puts "Audit log cleared: #{audit_file}"
-    else
-      puts "Audit log not found: #{audit_file}"
+    puts 'Claude Desktop Configuration:'
+    puts JSON.pretty_generate(config_template)
+    puts ''
+    puts 'Add this to your Claude Desktop configuration file:'
+    puts '  macOS/Linux: ~/.config/claude-desktop/claude_desktop_config.json'
+    puts '  Windows: %APPDATA%\\Claude\\claude_desktop_config.json'
+  end
+
+  desc 'Show comprehensive status and diagnostics'
+  task status: :environment do
+    puts 'Rails Active MCP Status Report'
+    puts '=' * 50
+
+    # Basic environment info
+    puts "\n📋 Environment Information:"
+    puts "  Rails version: #{Rails.version}"
+    puts "  Ruby version: #{RUBY_VERSION}"
+    puts "  Rails environment: #{Rails.env}"
+    puts "  Rails Active MCP version: #{RailsActiveMcp::VERSION}"
+
+    # Configuration status
+    puts "\n⚙️  Configuration Status:"
+    config = RailsActiveMcp.config
+    puts "  Valid: #{config.valid? ? '✅' : '❌'}"
+    puts "  Safe mode: #{config.safe_mode ? '🔒 Enabled' : '⚠️  Disabled'}"
+    puts "  Timeout: #{config.command_timeout}s"
+    puts "  Max results: #{config.max_results}"
+
+    # File status
+    puts "\n📁 File Status:"
+    files_to_check = [
+      'bin/rails-active-mcp-server',
+      'bin/rails-active-mcp-wrapper',
+      'config/initializers/rails_active_mcp.rb'
+    ]
+
+    files_to_check.each do |file|
+      full_path = Rails.root.join(file)
+      if File.exist?(full_path)
+        executable = File.executable?(full_path)
+        puts "  #{file}: ✅ #{'(executable)' if executable}"
+      else
+        puts "  #{file}: ❌ Missing"
+      end
+    end
+
+    # Test basic functionality
+    puts "\n🧪 Functionality Test:"
+    begin
+      test_result = RailsActiveMcp.execute('1 + 1')
+      puts "  Basic execution: #{test_result[:success] ? '✅' : '❌'}"
+    rescue StandardError => e
+      puts "  Basic execution: ❌ (#{e.message})"
     end
+
+    puts "\n🔗 Integration URLs:"
+    puts '  Documentation: https://github.com/goodpie/rails-active-mcp'
+    puts '  Issues: https://github.com/goodpie/rails-active-mcp/issues'
+    puts '  MCP Protocol: https://modelcontextprotocol.io'
   end
-end
+end

data/lib/rails_active_mcp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsActiveMcp
-  VERSION = '2.0.7'
+  VERSION = '2.0.12'
 end

data/lib/rails_active_mcp.rb

@@ -5,6 +5,7 @@ require_relative 'rails_active_mcp/version'
 require_relative 'rails_active_mcp/configuration'
 require_relative 'rails_active_mcp/safety_checker'
 require_relative 'rails_active_mcp/console_executor'
+require_relative 'rails_active_mcp/garbage_collection_utils'
 
 # Load SDK server
 require_relative 'rails_active_mcp/sdk/server'
@@ -42,15 +43,15 @@ module RailsActiveMcp
     end
 
     # Logger accessor - configured by engine or defaults to stderr
-    attr_accessor :logger
-
     def logger
       @logger ||= Logger.new($stderr).tap do |logger|
         logger.level = Logger::INFO
-        logger.formatter = proc do |severity, datetime, progname, msg|
+        logger.formatter = proc do |severity, datetime, _progname, msg|
           "[#{datetime}] #{severity} -- RailsActiveMcp: #{msg}\n"
         end
       end
     end
+
+    attr_writer :logger
   end
 end

data/mcp.ru

@@ -1,5 +1,5 @@
-require_relative "config/environment"
-require_relative "lib/rails_active_mcp"
+require_relative 'config/environment'
+require_relative 'lib/rails_active_mcp'
 
 # Run the Rails Active MCP server
 run RailsActiveMcp::McpServer.new

data/rails_active_mcp.gemspec

@@ -8,34 +8,62 @@ Gem::Specification.new do |spec|
   spec.authors = ['Brandyn Britton']
   spec.email = ['brandynbb96@gmail.com']
 
-  spec.summary = 'Rails Console access via Model Context Protocol (MCP)'
-  spec.description = 'Secure Rails console access for AI agents through Model Context Protocol with safety features and read-only modes'
+  spec.summary = 'Secure Rails console access via Model Context Protocol (MCP)'
+  spec.description = <<~DESC
+    Rails Active MCP enables secure Rails console access through Model Context Protocol (MCP)#{' '}
+    for AI agents and development tools like Claude Desktop. Provides safe database querying,#{' '}
+    model introspection, and code execution with comprehensive safety checks and audit logging.
+
+    Features include:
+    • Safe Ruby code execution with configurable safety checks
+    • Read-only database query tools with result limiting
+    • Rails model introspection (schema, associations, validations)
+    • Dry-run code analysis for safety validation
+    • Environment-specific configuration presets
+    • Comprehensive audit logging and monitoring
+    • Claude Desktop integration out of the box
+  DESC
+
   spec.homepage = 'https://github.com/goodpie/rails-active-mcp'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata = {
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => "#{spec.homepage}/tree/main",
+    'changelog_uri' => "#{spec.homepage}/blob/main/changelog.md",
+    'bug_tracker_uri' => "#{spec.homepage}/issues",
+    'documentation_uri' => "#{spec.homepage}#readme",
+    'wiki_uri' => "#{spec.homepage}/wiki",
+    'mailing_list_uri' => "#{spec.homepage}/discussions",
+    'funding_uri' => 'https://github.com/sponsors/goodpie',
+    'rubygems_mfa_required' => 'true'
+  }
 
-  # Specify which files should be added to the gem when it is released.
+  # Specify which files should be added to the gem when it is released
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile]) ||
+        f.match?(%r{\A(?:log|tmp|\.)/}) ||
+        f.end_with?('.log', '.tmp')
     end
-  end
+  end + [
+    'examples/rails_app_integration.md',
+    'docs/DEBUGGING.md',
+    'docs/README.md'
+  ].select { |f| File.exist?(f) }
 
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   # Runtime dependencies - more flexible Rails version support
-  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.3'
-  spec.add_runtime_dependency 'rails', '>= 6.1', '< 9.0'
+  spec.add_dependency 'concurrent-ruby', '~> 1.3'
+  spec.add_dependency 'rails', '>= 6.1', '< 9.0'
 
   # MCP SDK - Core protocol implementation
-  spec.add_runtime_dependency 'mcp', '~> 0.1.0'
+  spec.add_dependency 'mcp', '~> 0.1.0'
 
   # Core dependencies
   spec.add_dependency 'json', '~> 2.0'
@@ -44,11 +72,31 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'webrick', '~> 1.8'
 
   # Development dependencies - keep versions consistent with Gemfile
+  spec.add_development_dependency 'colorize', '~> 0.8'
   spec.add_development_dependency 'factory_bot_rails', '~> 6.0'
+  spec.add_development_dependency 'faker', '~> 2.19'
   spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
   spec.add_development_dependency 'rubocop', '~> 1.77'
   spec.add_development_dependency 'rubocop-rails', '~> 2.32'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-rspec', '~> 3.0'
   spec.add_development_dependency 'sqlite3', '~> 2.7'
+
+  # Post-install message to help users get started
+  spec.post_install_message = <<~MSG
+
+    🎉 Thanks for installing Rails Active MCP!
+
+    Quick Start:
+    1. Add to your Rails app: rails generate rails_active_mcp:install
+    2. Test the setup: rails rails_active_mcp:status
+    3. Configure Claude Desktop: rails rails_active_mcp:install_claude_config
+
+    📚 Documentation: #{spec.homepage}#readme
+    🐛 Issues: #{spec.homepage}/issues
+    💬 Discussions: #{spec.homepage}/discussions
+
+    Follow the project: ⭐ #{spec.homepage}
+
+  MSG
 end