rails-active-mcp 2.0.7 → 2.0.12

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,34 @@
+# Rails 7.0 Gemfile for CI testing
+source 'https://rubygems.org'
+
+# Specify the Rails version
+gem 'rails', '~> 7.0.0'
+
+# Include the main gemspec
+gemspec path: '../'
+
+group :development, :test do
+  gem 'byebug'
+  gem 'database_cleaner-active_record', '~> 2.1'
+  gem 'factory_bot_rails', '~> 6.0'
+  gem 'rspec', '~> 3.1'
+  gem 'rspec-rails'
+  gem 'sqlite3', '~> 2.7'
+  gem 'timecop', '~> 0.9.8'
+  gem 'webmock', '~> 3.19'
+end
+
+group :development do
+  gem 'redcarpet' # For YARD markdown support
+  gem 'rubocop', '~> 1.77'
+  gem 'rubocop-rails', '~> 2.32'
+  gem 'rubocop-rspec'
+  gem 'simplecov', '~> 0.22'
+  gem 'yard'
+end
+
+# For testing the gem in a Rails app
+gem 'sprockets-rails' # Required for Rails 7+
+
+# Official MCP Ruby SDK for migration
+gem 'mcp', '~> 0.1.0'

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,34 @@
+# Rails 7.1 Gemfile for CI testing
+source 'https://rubygems.org'
+
+# Specify the Rails version
+gem 'rails', '~> 7.1.0'
+
+# Include the main gemspec
+gemspec path: '../'
+
+group :development, :test do
+  gem 'byebug'
+  gem 'database_cleaner-active_record', '~> 2.1'
+  gem 'factory_bot_rails', '~> 6.0'
+  gem 'rspec', '~> 3.1'
+  gem 'rspec-rails'
+  gem 'sqlite3', '~> 2.7'
+  gem 'timecop', '~> 0.9.8'
+  gem 'webmock', '~> 3.19'
+end
+
+group :development do
+  gem 'redcarpet' # For YARD markdown support
+  gem 'rubocop', '~> 1.77'
+  gem 'rubocop-rails', '~> 2.32'
+  gem 'rubocop-rspec'
+  gem 'simplecov', '~> 0.22'
+  gem 'yard'
+end
+
+# For testing the gem in a Rails app
+gem 'sprockets-rails' # Required for Rails 7+
+
+# Official MCP Ruby SDK for migration
+gem 'mcp', '~> 0.1.0'

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,34 @@
+# Rails 7.2 Gemfile for CI testing
+source 'https://rubygems.org'
+
+# Specify the Rails version
+gem 'rails', '~> 7.2.0'
+
+# Include the main gemspec
+gemspec path: '../'
+
+group :development, :test do
+  gem 'byebug'
+  gem 'database_cleaner-active_record', '~> 2.1'
+  gem 'factory_bot_rails', '~> 6.0'
+  gem 'rspec', '~> 3.1'
+  gem 'rspec-rails'
+  gem 'sqlite3', '~> 2.7'
+  gem 'timecop', '~> 0.9.8'
+  gem 'webmock', '~> 3.19'
+end
+
+group :development do
+  gem 'redcarpet' # For YARD markdown support
+  gem 'rubocop', '~> 1.77'
+  gem 'rubocop-rails', '~> 2.32'
+  gem 'rubocop-rspec'
+  gem 'simplecov', '~> 0.22'
+  gem 'yard'
+end
+
+# For testing the gem in a Rails app
+gem 'sprockets-rails' # Required for Rails 7+
+
+# Official MCP Ruby SDK for migration
+gem 'mcp', '~> 0.1.0'

data/lib/generators/rails_active_mcp/install/install_generator.rb

@@ -3,7 +3,7 @@
 module RailsActiveMcp
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path('templates', __dir__ || File.dirname(__FILE__))
 
       desc 'Install Rails Active MCP'
 
@@ -11,81 +11,14 @@ module RailsActiveMcp
         template 'initializer.rb', 'config/initializers/rails_active_mcp.rb'
       end
 
-      def create_binstub
-        # Create binstub for easy server execution
-        create_file 'bin/rails-active-mcp-server', <<~RUBY
-          #!/usr/bin/env ruby
-
-          # Binstub for Rails Active MCP Server
-          # This ensures the server runs within the Rails project context
-
-          require 'bundler/setup'
-
-          # Set Rails environment
-          ENV['RAILS_ENV'] ||= 'development'
-
-          # Load Rails application first
-          require_relative '../config/environment'
-
-          # Now start the MCP server using the SDK implementation
-          require 'rails_active_mcp/sdk/server'
-
-          begin
-            server = RailsActiveMcp::SDK::Server.new
-            server.run
-          rescue StandardError => e
-            warn "Error starting Rails Active MCP server: \#{e.message}"
-            warn e.backtrace if ENV['RAILS_MCP_DEBUG'] == '1'
-            exit 1
-          end
-        RUBY
+      def create_wrapper_script
+        template 'rails-active-mcp-wrapper', 'bin/rails-active-mcp-wrapper'
+        chmod 'bin/rails-active-mcp-wrapper', 0o755
+      end
 
+      def create_server_script
+        template 'rails-active-mcp-server', 'bin/rails-active-mcp-server'
         chmod 'bin/rails-active-mcp-server', 0o755
-        say 'Created Rails binstub at bin/rails-active-mcp-server', :green
-
-        # Create environment-aware wrapper for Claude Desktop compatibility
-        ruby_path = `which ruby`.strip
-
-        create_file 'bin/rails-active-mcp-wrapper', <<~BASH
-          #!/usr/bin/env bash
-
-          # Rails Active MCP Wrapper Script
-          # Ensures correct Ruby environment for Claude Desktop execution
-
-          # Fix Claude Desktop environment isolation issues
-          export HOME="${HOME:-#{ENV['HOME']}}"
-          export USER="${USER:-$(whoami)}"
-
-          # Strategy 1: Use absolute Ruby path (most reliable)
-          RUBY_PATH="#{ruby_path}"
-
-          # Strategy 2: Try /usr/local/bin/ruby symlink as fallback
-          if [ ! -x "$RUBY_PATH" ]; then
-              RUBY_PATH="/usr/local/bin/ruby"
-          fi
-
-          # Strategy 3: Setup environment and use PATH resolution as last resort
-          if [ ! -x "$RUBY_PATH" ]; then
-              # Set up asdf environment if available
-              export ASDF_DIR="$HOME/.asdf"
-              if [ -f "$ASDF_DIR/asdf.sh" ]; then
-                  source "$ASDF_DIR/asdf.sh"
-              fi
-          #{'    '}
-              # Add version manager paths
-              export PATH="$HOME/.asdf/shims:$HOME/.rbenv/shims:$HOME/.rvm/bin:$PATH"
-              RUBY_PATH="ruby"
-          fi
-
-          # Change to the Rails project directory
-          cd "$(dirname "$0")/.."
-
-          # Execute with the determined Ruby path
-          exec "$RUBY_PATH" bin/rails-active-mcp-server "$@"
-        BASH
-
-        chmod 'bin/rails-active-mcp-wrapper', 0o755
-        say 'Created environment wrapper at bin/rails-active-mcp-wrapper', :green
       end
 
       def create_mcp_config
@@ -96,59 +29,76 @@ module RailsActiveMcp
         readme 'README.md' if behavior == :invoke
       end
 
+      # rubocop:disable Metrics/AbcSize
       def show_post_install_instructions
         return unless behavior == :invoke
 
-        say "\n" + '=' * 50, :green
+        say "\n#{'=' * 50}", :green
         say 'Rails Active MCP Installation Complete!', :green
         say '=' * 50, :green
+        say "\nFiles created:", :green
+        say '✅ config/initializers/rails_active_mcp.rb', :yellow
+        say '✅ bin/rails-active-mcp-wrapper', :yellow
+        say '✅ bin/rails-active-mcp-server', :yellow
+        say '✅ mcp.ru', :yellow
+        say '', :green
+        say "\nQuick Test:", :green
+        say '1. Test the server: bin/rails-active-mcp-wrapper', :yellow
+        say '2. Should show JSON responses (not plain text)', :yellow
+        say '3. Exit with Ctrl+C', :yellow
+        say '', :green
         say "\nFor Claude Desktop configuration:", :green
         say 'Add this to your claude_desktop_config.json:', :yellow
         say '', :green
         say '{', :cyan
         say '  "mcpServers": {', :cyan
         say '    "rails-active-mcp": {', :cyan
-        say "      \"command\": \"#{Rails.root}/bin/rails-active-mcp-wrapper\",", :cyan
+        say "      \"command\": \"#{Rails.root.join('bin/rails-active-mcp-wrapper')}\",", :cyan
         say "      \"cwd\": \"#{Rails.root}\",", :cyan
         say '      "env": {', :cyan
-        say '        "RAILS_ENV": "development",', :cyan
-        say "        \"HOME\": \"#{ENV['HOME']}\"", :cyan
+        say '        "RAILS_ENV": "development"', :cyan
         say '      }', :cyan
         say '    }', :cyan
         say '  }', :cyan
         say '}', :cyan
         say '', :green
+        say 'Config file locations:', :green
+        say '  macOS: ~/.config/claude-desktop/claude_desktop_config.json', :yellow
+        say '  Windows: %APPDATA%\\Claude\\claude_desktop_config.json', :yellow
+        say '', :green
         say "\nAvailable Tools in Claude Desktop:", :green
         say '- console_execute: Execute Ruby code with safety checks', :yellow
         say '- model_info: Get detailed information about Rails models', :yellow
         say '- safe_query: Execute safe read-only database queries', :yellow
         say '- dry_run: Analyze Ruby code for safety without execution', :yellow
         say '', :green
-        say "\nWhy use the wrapper?", :green
-        say '- Handles Ruby version manager environments (asdf, rbenv, etc.)', :yellow
-        say '- Prevents "bundler version" and "Ruby version" conflicts', :yellow
-        say '- Works reliably across different development setups', :yellow
-        say "\nAlternative (if wrapper doesn't work):", :green
-        say 'Use bin/rails-active-mcp-server instead of the wrapper', :yellow
-        say "\nTesting:", :green
-        say '1. Test manually: bin/rails-active-mcp-wrapper', :yellow
-        say '2. Should output JSON responses (not plain text)', :yellow
-        say '3. Restart Claude Desktop after config changes', :yellow
+        say "\nExample Claude Desktop prompts:", :green
+        say '- "Show me the User model structure"', :yellow
+        say '- "How many users were created in the last week?"', :yellow
+        say '- "What are the most recent orders?"', :yellow
+        say '- "Check if this code is safe: User.delete_all"', :yellow
+        say '', :green
         say "\nTroubleshooting:", :green
-        say '- Set RAILS_MCP_DEBUG=1 for verbose logging', :yellow
-        say '- Check README.md for more configuration options', :yellow
-        say "\nFor Ruby version manager users (asdf/rbenv/RVM):", :green
-        say 'If you encounter "bundler version" errors, create a system symlink:', :yellow
-        say "sudo ln -sf #{`which ruby`.strip} /usr/local/bin/ruby", :cyan
+        say '- Debug mode: RAILS_MCP_DEBUG=1 bin/rails-active-mcp-wrapper', :yellow
+        say '- Check status: rails rails_active_mcp:status', :yellow
+        say '- Restart Claude Desktop after config changes', :yellow
+        say '- If wrapper fails, try: bin/rails-active-mcp-server', :yellow
+        say '', :green
+        say "\nNext steps:", :green
+        say '1. Test installation: rails rails_active_mcp:test_tools', :yellow
+        say '2. Configure Claude Desktop (see above)', :yellow
+        say '3. Restart Claude Desktop', :yellow
+        say '4. Start chatting with your Rails app!', :yellow
         say '=' * 50, :green
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
       def readme(path)
         readme_path = File.join(self.class.source_root, path)
         if File.exist?(readme_path)
-          say IO.read(readme_path), :green
+          say File.read(readme_path), :green
         else
           say "README file not found at #{readme_path}", :green
         end

data/lib/generators/rails_active_mcp/install/templates/README.md

@@ -1,54 +1,134 @@
-================================================================================
-Rails Active MCP Installation Complete!
-================================================================================
-
-🎉 Rails Active MCP v2.0 with Official MCP Ruby SDK has been installed!
-
-📁 Files Created:
-- config/initializers/rails_active_mcp.rb (Configuration)
-- bin/rails-active-mcp-server (Main server executable)
-- bin/rails-active-mcp-wrapper (Environment wrapper for Claude Desktop)
-- mcp.ru (Rack configuration file)
-
-🛠️ Available MCP Tools:
-- console_execute: Execute Ruby code with safety checks
-- model_info: Get detailed information about Rails models  
-- safe_query: Execute safe read-only database queries
-- dry_run: Analyze Ruby code for safety without execution
-
-🚀 Quick Start:
-
-1. Test the server:
-   $ ./bin/rails-active-mcp-server
-
-2. For Claude Desktop, add to claude_desktop_config.json:
-   {
-     "mcpServers": {
-       "rails-active-mcp": {
-         "command": "/path/to/your/project/bin/rails-active-mcp-wrapper",
-         "cwd": "/path/to/your/project",
-         "env": {
-           "RAILS_ENV": "development",
-           "HOME": "/Users/your-username"
-         }
-       }
-     }
-   }
-
-3. Restart Claude Desktop and start using the tools!
-
-⚙️ Configuration:
-Edit config/initializers/rails_active_mcp.rb to customize:
-- allowed_commands: Shell commands that can be executed
-- command_timeout: Execution timeout in seconds
-- enable_logging: Enable/disable logging
-- log_level: Logging verbosity (:debug, :info, :warn, :error)
-
-🔧 Troubleshooting:
-- Use the wrapper script to avoid Ruby version manager conflicts
-- Set RAILS_MCP_DEBUG=1 for verbose logging
-- Ensure Claude Desktop has correct paths and environment variables
-
-📚 Documentation: https://github.com/goodpie/rails-active-mcp
-
-================================================================================
+# Rails Active MCP Integration
+
+This Rails application is configured with Rails Active MCP for secure AI-powered database querying and model inspection.
+
+## What is Rails Active MCP?
+
+Rails Active MCP enables secure Rails console access through Model Context Protocol (MCP) for AI agents and development tools like Claude Desktop. It provides four main tools:
+
+- **console_execute**: Execute Ruby/Rails code with safety checks
+- **model_info**: Inspect Rails models (schema, associations, validations)
+- **safe_query**: Run read-only database queries
+- **dry_run**: Analyze code safety without execution
+
+## Quick Start
+
+### 1. Test the Installation
+
+```bash
+# Test the server starts correctly
+bin/rails-active-mcp-wrapper
+
+# Enable debug mode for troubleshooting
+RAILS_MCP_DEBUG=1 bin/rails-active-mcp-server
+```
+
+### 2. Configure Claude Desktop
+
+Add this to your Claude Desktop configuration:
+
+**macOS/Linux**: `~/.config/claude-desktop/claude_desktop_config.json`
+**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "rails-active-mcp": {
+      "command": "/path/to/your/rails/app/bin/rails-active-mcp-wrapper",
+      "cwd": "/path/to/your/rails/app",
+      "env": {
+        "RAILS_ENV": "development"
+      }
+    }
+  }
+}
+```
+
+### 3. Try These Commands in Claude Desktop
+
+- "Show me the User model structure"
+- "How many users were created in the last week?"
+- "What are the most recent orders?"
+- "Check if this code is safe: `User.delete_all`"
+
+## Configuration
+
+Your MCP integration is configured in `config/initializers/rails_active_mcp.rb`.
+
+### Environment-Specific Settings
+
+- **Development**: More permissive, verbose logging
+- **Production**: Strict safety, limited results, audit logging
+- **Test**: Minimal logging, safety enabled
+
+### Customizing Safety Rules
+
+```ruby
+# Add custom safety patterns
+config.custom_safety_patterns = [
+  { pattern: /YourDangerousMethod/, description: "Custom dangerous operation" }
+]
+
+# Restrict model access (empty = allow all)
+config.allowed_models = %w[User Post Comment]
+```
+
+## Available Rake Tasks
+
+```bash
+# Check code safety
+rails rails_active_mcp:check_safety['User.count']
+
+# Execute code with safety checks  
+rails rails_active_mcp:execute['User.count']
+
+# Test MCP tools
+rails rails_active_mcp:test_tools
+```
+
+## Troubleshooting
+
+### Server Won't Start
+- Ensure your Rails app starts without errors: `rails console`
+- Check Ruby version compatibility
+- Verify all gems are installed: `bundle install`
+
+### Claude Desktop Connection Issues
+- Restart Claude Desktop after configuration changes
+- Check logs: `~/Library/Logs/Claude/mcp*.log` (macOS)
+- Test server manually: `bin/rails-active-mcp-wrapper`
+
+### Permission Errors
+- Ensure wrapper script is executable: `chmod +x bin/rails-active-mcp-wrapper`
+- Check Ruby path in wrapper script matches your setup
+
+## Security Notes
+
+- All dangerous operations are blocked by default in safe mode
+- Production mode enables the strictest safety settings
+- All executions can be logged for audit purposes
+- Model access can be restricted via configuration
+
+## Examples
+
+### Safe Operations (Always Allowed)
+```ruby
+User.count
+Post.where(published: true).limit(10)
+User.find(1).posts.includes(:comments)
+Rails.env
+```
+
+### Risky Operations (Blocked in Safe Mode)
+```ruby
+User.delete_all        # Mass deletion
+system('rm -rf /')     # System commands
+eval(user_input)       # Code evaluation
+File.delete('file')    # File operations
+```
+
+## Getting Help
+
+- **Documentation**: https://github.com/goodpie/rails-active-mcp
+- **Issues**: https://github.com/goodpie/rails-active-mcp/issues
+- **MCP Protocol**: https://modelcontextprotocol.io

data/lib/generators/rails_active_mcp/install/templates/initializer.rb

@@ -16,15 +16,45 @@ RailsActiveMcp.configure do |config|
   config.enable_logging = true
   config.log_level = :info # :debug, :info, :warn, :error
 
+  # Safety configuration
+  config.safe_mode = true        # Enable safety checks by default
+  config.max_results = 100       # Limit query results to prevent large dumps
+  config.log_executions = true   # Log all executions for audit trail
+
+  # Model access control (empty arrays allow all)
+  config.allowed_models = [] # Whitelist specific models if needed
+  # config.allowed_models = %w[User Post Comment] # Example: restrict to specific models
+
+  # Custom safety patterns for your application
+  # config.custom_safety_patterns = [
+  #   { pattern: /YourDangerousMethod/, description: "Your custom dangerous operation" }
+  # ]
+
   # Environment-specific adjustments
-  if Rails.env.production?
-    # More restrictive settings for production
+  case Rails.env
+  when 'production'
+    # Strict settings for production
+    config.safe_mode = true
     config.log_level = :warn
     config.command_timeout = 15
-  elsif Rails.env.development?
+    config.max_results = 50
+    config.log_executions = true
+    config.allowed_models = [] # Consider restricting models in production
+
+  when 'development'
     # More permissive settings for development
+    config.safe_mode = false # Allow more operations during development
     config.log_level = :debug
     config.command_timeout = 60
+    config.max_results = 200
+    config.log_executions = false
+
+  when 'test'
+    # Test-friendly settings
+    config.safe_mode = true
+    config.log_level = :error
+    config.command_timeout = 30
+    config.log_executions = false
   end
 end
 
@@ -36,7 +66,15 @@ end
 # - safe_query: Execute safe read-only database queries
 # - dry_run: Analyze Ruby code for safety without execution
 #
-# To start the server:
-#   bin/rails-active-mcp-server
+# Quick Start:
+# 1. Start the server: bin/rails-active-mcp-server
+# 2. Configure Claude Desktop (see post-install instructions)
+# 3. Try asking Claude: "Show me all users created in the last week"
+#
+# Testing the installation:
+# - Run: bin/rails-active-mcp-wrapper (should output JSON responses)
+# - Test with: RAILS_MCP_DEBUG=1 bin/rails-active-mcp-server
+# - Check rake tasks: rails -T rails_active_mcp
 #
-# For Claude Desktop integration, see the post-install instructions.
+# Documentation: https://github.com/goodpie/rails-active-mcp
+# Need help? Create an issue or check the troubleshooting guide.

data/lib/generators/rails_active_mcp/install/templates/rails-active-mcp-server

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Rails Active MCP Server Script
+# This script starts the Rails Active MCP server for your Rails application
+
+# Ensure we're in the Rails application directory
+unless File.exist?('config/environment.rb') && File.exist?('Gemfile')
+  puts 'Error: This script must be run from the root of a Rails application'
+  puts "Current directory: #{Dir.pwd}"
+  puts 'Please ensure you have both config/environment.rb and Gemfile in your project root'
+  exit(1)
+end
+
+# Load bundler and ensure the gem is available
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  puts "Error: Bundler not available: #{e.message}"
+  puts 'Please run: gem install bundler'
+  exit(1)
+end
+
+# Check if rails-active-mcp is in the bundle
+begin
+  gem 'rails-active-mcp'
+rescue Gem::LoadError
+  puts 'Error: rails-active-mcp gem not found in bundle'
+  puts "Please add to your Gemfile: gem 'rails-active-mcp'"
+  puts 'Then run: bundle install'
+  exit(1)
+end
+
+# Load Rails environment
+begin
+  require_relative '../config/environment'
+rescue LoadError => e
+  puts "Error: Failed to load Rails environment: #{e.message}"
+  puts 'Please ensure your Rails application is properly configured'
+  exit(1)
+end
+
+# Load Rails Active MCP
+begin
+  require 'rails_active_mcp'
+rescue LoadError => e
+  puts "Error: Failed to load Rails Active MCP: #{e.message}"
+  puts 'Please ensure the gem is properly installed'
+  exit(1)
+end
+
+# Ensure configuration is loaded
+unless RailsActiveMcp.configuration
+  puts 'Warning: Rails Active MCP configuration not found'
+  puts 'Please run: rails generate rails_active_mcp:install'
+  puts 'Using default configuration...'
+  RailsActiveMcp.configure
+end
+
+# Start the server
+begin
+  require 'rails_active_mcp/sdk/server'
+
+  # Parse command line arguments
+  transport = ARGV[0] || 'stdio'
+
+  case transport
+  when 'stdio', nil
+    puts 'Starting Rails Active MCP Server in stdio mode...' if ENV['RAILS_MCP_DEBUG']
+    server = RailsActiveMcp::Sdk::Server.new
+    server.run_stdio
+  when '--help', '-h'
+    puts <<~HELP
+      Rails Active MCP Server
+
+      Usage: #{File.basename($PROGRAM_NAME)} [mode] [options]
+
+      Modes:
+        stdio     Start in stdio mode for MCP integration (default)
+        --help    Show this help message
+
+      Environment Variables:
+        RAILS_MCP_DEBUG=1    Enable debug logging
+        RAILS_ENV=env        Set Rails environment (default: development)
+
+      Examples:
+        #{File.basename($PROGRAM_NAME)}                    # Start in stdio mode
+        #{File.basename($PROGRAM_NAME)} stdio              # Start in stdio mode explicitly
+        RAILS_MCP_DEBUG=1 #{File.basename($PROGRAM_NAME)}  # Start with debug logging
+    HELP
+  else
+    puts "Error: Unknown transport mode '#{transport}'"
+    puts 'Use --help for usage information'
+    exit(1)
+  end
+rescue Interrupt
+  puts "\nServer stopped by user"
+  exit(0)
+rescue StandardError => e
+  puts "Error: Failed to start server: #{e.message}"
+  puts 'Backtrace:' if ENV['RAILS_MCP_DEBUG']
+  puts e.backtrace if ENV['RAILS_MCP_DEBUG']
+  exit(1)
+end