rails-active-mcp 2.0.12 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fee611445971a5e113a23146281a9f2a68d0c8c0690213df2704ee7fb80f7700
-  data.tar.gz: ce6ba7ab86616fd0a5a0e60aff50e9c4e8f29101a9866597e1dfd99ef2c6ee85
+  metadata.gz: 5e6f12134560393b1599733a6930210fa87e4855256b6554395847d81e1690c0
+  data.tar.gz: cdec6fde55f4fcf3e0bcb78960dcd3464e84e358a1206baf7ebb41984a40ed21
 SHA512:
-  metadata.gz: 312b0f2384b4cc7a57b0be9284a52c559897d10e31487eb859cd70b9e5dc385a1005a245cff4a42b7d3abe7f0480b1fdcd8caa317e7ff2388fbeb635ed447c13
-  data.tar.gz: 875467cc1ad75645d32607f2c6c3a98951807da776b626dc113f186720fc6042fe90303fe19ae8c230f036a2a085e6caa1e38e518da0a3ef71356d2cbbce10fd
+  metadata.gz: e7abbeeff33ad044bd08d73550c9dc1b24dcced7db200734c2842b0c7760533d2fdeb388c5e468e6216807a0bbca03c6dc36620495d335f71966d78d5e2b0557
+  data.tar.gz: 895df97ae5a0880df7b06781c64f9655b9464df36892174214a222079eff8825b3765f12278c51418a81b671831256ccf72ce3336213b3882504da7c0112b082

data/.dockerignore

@@ -0,0 +1,38 @@
+# Git
+.git
+.gitignore
+
+# Documentation
+*.md
+docs/
+examples/
+
+# Development files
+.vscode/
+.idea/
+*.sublime-*
+
+# Ruby/Rails
+*.gem
+.bundle/
+vendor/bundle
+log/
+tmp/
+.byebug_history
+
+# Testing
+coverage/
+spec/reports/
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# CI/CD
+.github/
+
+# Keep these for the build
+!Gemfile
+!Gemfile.lock
+!rails_active_mcp.gemspec
+!lib/rails_active_mcp/version.rb

data/.rubocop.yml

@@ -5,7 +5,7 @@ plugins:
 AllCops:
   NewCops: enable
   SuggestExtensions: false
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.2
   Exclude:
     - 'bin/bundle'
     - 'bin/setup'
@@ -70,9 +70,8 @@ Style/SafeNavigation:
 Style/StringLiterals:
   EnforcedStyle: single_quotes
 
-# Don't enforce frozen string literals in every file
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 # Allow numeric comparisons with zero
 Style/NumericPredicate:
@@ -90,12 +89,9 @@ RSpec:
 Gemspec/DevelopmentDependencies:
   Enabled: false
 
-# Allow some duplication in methods that handle similar cases
-Lint/DuplicateMethods:
-  Enabled: false
-
 Lint/DuplicateBranch:
-  Enabled: false
+  Exclude:
+    - 'lib/rails_active_mcp/console_executor.rb'
 
 # RSpec specific overrides for test quality
 RSpec/MultipleExpectations:
@@ -131,9 +127,13 @@ RSpec/ScatteredSetup:
 RSpec/SpecFilePathFormat:
   Enabled: false
 
-# Allow Time.zone vs Time.now flexibility
 Rails/TimeZone:
-  Enabled: false
+  Enabled: true
+  Exclude:
+    - 'exe/*'
+    - 'lib/rails_active_mcp/sdk/server.rb'
+    - 'lib/rails_active_mcp/console_executor.rb'
+    - 'spec/**/*'
 
 # Naming conventions - allow short parameter names in specs/tools
 Naming/MethodParameterName:

data/.ruby-version

@@ -0,0 +1 @@
+3.4.8

data/Dockerfile

@@ -0,0 +1,25 @@
+FROM ruby:3.4-slim
+
+# Install system dependencies
+RUN apt-get update -qq && \
+    apt-get install -y --no-install-recommends \
+    build-essential \
+    git \
+    libsqlite3-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set working directory
+WORKDIR /app
+
+# Copy gemspec and Gemfile first for better layer caching
+COPY rails_active_mcp.gemspec Gemfile* ./
+COPY lib/rails_active_mcp/version.rb ./lib/rails_active_mcp/
+
+# Install gem dependencies
+RUN bundle install
+
+# Copy the rest of the application
+COPY . .
+
+# Default command
+CMD ["bash"]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Brandyn Britton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,87 +1,43 @@
+[![Gem Version](https://badge.fury.io/rb/rails-active-mcp.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/rails-active-mcp)
+
+Note: This is just a personal project and while it works for the most part, I am still developing it and actively trying to make it a bit more useful for my uses.
+
 # Rails Active MCP
 
 A Ruby gem that provides secure Rails console access through Model Context Protocol (MCP) for AI agents and development tools like Claude Desktop. Built using the official MCP Ruby SDK for professional protocol handling and future-proof compatibility.
 
-## Features
 
-- 🔒 **Safe Execution**: Advanced safety checks prevent dangerous operations
-- 🚀 **Official MCP SDK**: Built with the official MCP Ruby SDK for robust protocol handling
-- 📊 **Read-Only Queries**: Safe database querying with automatic result limiting
-- 🔍 **Code Analysis**: Dry-run capabilities to analyze code before execution
-- 📝 **Audit Logging**: Complete execution logging for security and debugging
-- ⚙️ **Configurable**: Flexible configuration for different environments
-- 🛡️ **Production Ready**: Strict safety modes for production environments
-- ⚡ **Professional Implementation**: Built-in instrumentation, timing, and error handling
 
-## Installation
+## Quick Start
+
+Get up and running in three steps:
+
+### 1. Install the gem
 
-Add this line to your application's Gemfile:
+Add to your Rails application's `Gemfile`:
 
 ```ruby
 gem 'rails-active-mcp'
 ```
 
-And then execute:
-
 ```bash
 bundle install
 ```
 
-Run the installer:
+### 2. Run the installer
 
 ```bash
 rails generate rails_active_mcp:install
 ```
 
-This will:
-
-- Create an initializer with configuration options
-- Mount the MCP server for Rails integration
-- Create a `mcp.ru` server file for standalone usage
-- Set up audit logging
-
-## Configuration
-
-The gem is configured in `config/initializers/rails_active_mcp.rb`:
-
-```ruby
-RailsActiveMcp.configure do |config|
-  # Core configuration options
-  config.allowed_commands = %w[
-    ls pwd cat head tail grep find wc
-    rails console rails runner
-    bundle exec rspec bundle exec test
-    git status git log git diff
-  ]
-  config.command_timeout = 30
-  config.enable_logging = true
-  config.log_level = :info
-end
-```
-
-## Running the MCP Server
-
-The server runs in STDIO mode, perfect for Claude Desktop integration:
-
-```bash
-$ bundle exec rails-active-mcp-server
-```
+This creates an initializer, mounts the MCP engine, and generates a standalone server file.
 
-The server automatically:
-- Loads your Rails application
-- Initializes all models and configurations
-- Provides secure access to your Rails environment
-- Uses the official MCP Ruby SDK for protocol handling
+### 3. Connect to Claude Desktop
 
-## Usage
+Add the following to your Claude Desktop configuration file:
 
-### Claude Desktop Integration (Recommended)
-
-Add to your Claude Desktop configuration file:
-
-**Location:**
-- macOS/Linux: `~/.config/claude-desktop/claude_desktop_config.json`
-- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
+- **macOS/Linux:** `~/.config/claude-desktop/claude_desktop_config.json`
+- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
 
 ```json
 {
@@ -95,28 +51,54 @@ Add to your Claude Desktop configuration file:
 }
 ```
 
-Or if installed globally:
-
-```json
-{
-  "mcpServers": {
-    "rails-active-mcp": {
-      "command": "rails-active-mcp-server",
-      "cwd": "/path/to/your/rails/project"
-    }
-  }
-}
-```
+Restart Claude Desktop, and you're done. Four tools will appear automatically: `console_execute`, `model_info`, `safe_query`, and `dry_run`.
 
-Then in Claude Desktop, you can use prompts like:
+Try asking Claude:
 
 - "Show me all users created in the last week"
 - "What's the average order value?"
 - "Check the User model schema and associations"
 - "Analyze this code for safety: User.delete_all"
 
+## Features
+
+- 🔒 **Safe Execution**: Advanced safety checks prevent dangerous operations
+- 🚀 **Official MCP SDK**: Built with the official MCP Ruby SDK for robust protocol handling
+- 📊 **Read-Only Queries**: Safe database querying with automatic result limiting
+- 🔍 **Code Analysis**: Dry-run capabilities to analyze code before execution
+- 📝 **Audit Logging**: Complete execution logging for security and debugging
+- ⚙️ **Configurable**: Flexible configuration for different environments
+- 🛡️ **Production Ready**: Strict safety modes for production environments
+- ⚡ **Professional Implementation**: Built-in instrumentation, timing, and error handling
+
+## Configuration
+
+The installer creates a default configuration at `config/initializers/rails_active_mcp.rb`. The defaults work out of the box, but you can customize behavior:
+
+```ruby
+RailsActiveMcp.configure do |config|
+  config.allowed_commands = %w[
+    ls pwd cat head tail grep find wc
+    rails console rails runner
+    bundle exec rspec bundle exec test
+    git status git log git diff
+  ]
+  config.command_timeout = 30
+  config.enable_logging = true
+  config.log_level = :info
+end
+```
+
+## Usage
+
+### Claude Desktop (Recommended)
+
+Once connected (see [Quick Start](#quick-start)), Claude Desktop automatically runs the MCP server for you. The server loads your Rails application, initializes models, and provides secure access to your Rails environment via STDIO transport.
+
 ### Direct Usage
 
+You can also use the gem directly in Ruby:
+
 ```ruby
 # Execute code safely
 result = RailsActiveMcp.execute("User.count")
@@ -125,6 +107,17 @@ result = RailsActiveMcp.execute("User.count")
 RailsActiveMcp.safe?("User.delete_all") # => false
 ```
 
+### Running the Server Manually
+
+If you need to run the server outside of Claude Desktop (e.g., for debugging):
+
+```bash
+bundle exec rails-active-mcp-server
+
+# With debug logging
+RAILS_MCP_DEBUG=1 bundle exec rails-active-mcp-server
+```
+
 ## Available MCP Tools
 
 The Rails Active MCP server provides four powerful tools that appear automatically in Claude Desktop:
@@ -249,26 +242,12 @@ All errors are properly reported through the MCP protocol with detailed messages
 
 ## Development and Testing
 
-### Running Tests
-
-```bash
-$ bundle exec rspec
-```
-
-### Testing MCP Integration
-
 ```bash
-$ ./bin/test-mcp-output
-```
-
-This tests the MCP server output redirection and JSON protocol compliance.
+# Run tests
+bundle exec rspec
 
-### Debugging
-
-Set the debug environment variable for detailed logging:
-
-```bash
-$ RAILS_MCP_DEBUG=1 bundle exec rails-active-mcp-server
+# Test MCP server protocol compliance
+./bin/test-mcp-output
 ```
 
 ## Contributing

data/changelog.md

@@ -7,6 +7,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+- CI: Expanded Rails matrix to include 8.0 and 8.1; added corresponding gemfiles.
+- CI: Output JUnit XML via rspec_junit_formatter and ensure tmp/ exists for artifacts.
+- CI: Fixed gem install step to use the correct hyphenated artifact name (rails-active-mcp-*.gem).
+
+## [3.1.0] - 2026-02-09
+
+### Changed
+
+- Updated MCP Ruby SDK from v0.4.0 to v0.7.0
+- Added server metadata (websiteUrl, description) for improved discoverability in Claude Desktop
+- Cleaned up duplicate gem declarations in Gemfile
+- **BREAKING**: Removed Rails < 7.0 support
+- Added Rails 8 support
+
+### Internal
+
+- Leveraged MCP SDK v0.7.0 (includes v0.6.0) icon optimization (omit when nil/empty)
+- Aligned with MCP SDK v0.5.0 serverInfo enhancements
+
+### Migration
+
+Run `bundle update mcp` to upgrade.
+
+## [3.0.0] - 2025-12-01
+
+### Changed
+
+- **BREAKING**: Updated to MCP Ruby SDK v0.4.0 (was v0.1.0)
+- **BREAKING**: Requires Ruby >= 3.2.0 (was >= 3.1.0)
+- **BREAKING**: Updated to MCP protocol version 2025-11-25
+- Tool error responses now include `is_error: true` flag per MCP 2025-11-25 specification
+
+### Fixed
+
+- Input validation errors are now returned as Tool Execution Errors instead of Protocol Errors (MCP 2025-11-25 compliance)
+
+### Migration Guide
+
+For users upgrading from v2.x:
+
+1. Ensure you are running Ruby 3.2.0 or higher
+2. Run `bundle update rails-active-mcp` to update the gem and its dependencies
+3. No configuration changes are required
+
 ## [2.0.0] - 2025-01-15
 
 ### Added
@@ -82,35 +127,35 @@ For users upgrading from v1.x:
 
 - Initial release of Rails Active MCP gem
 - Core MCP tools for Rails console access:
-    - `console_execute`: Execute Ruby code with safety checks
-    - `safe_query`: Execute read-only database queries
-    - `dry_run`: Analyze code safety without execution
-    - `model_info`: Get model schema and associations
+  - `console_execute`: Execute Ruby code with safety checks
+  - `safe_query`: Execute read-only database queries
+  - `dry_run`: Analyze code safety without execution
+  - `model_info`: Get model schema and associations
 - Advanced safety checking system:
-    - Pattern-based dangerous operation detection
-    - Configurable safety levels (critical, high, medium, low)
-    - Read-only operation detection
-    - Custom safety pattern support
+  - Pattern-based dangerous operation detection
+  - Configurable safety levels (critical, high, medium, low)
+  - Read-only operation detection
+  - Custom safety pattern support
 - Comprehensive configuration system:
-    - Environment-specific presets (production, development, test)
-    - Model access control (allow/block lists)
-    - Timeout and result limiting
-    - Audit logging configuration
+  - Environment-specific presets (production, development, test)
+  - Model access control (allow/block lists)
+  - Timeout and result limiting
+  - Audit logging configuration
 - Rails integration:
-    - Rails engine for automatic setup
-    - Generator for easy installation
-    - Rake tasks for management and testing
-    - Active MCP integration
+  - Rails engine for automatic setup
+  - Generator for easy installation
+  - Rake tasks for management and testing
+  - Active MCP integration
 - Security features:
-    - Execution timeout protection
-    - Result size limiting
-    - Complete audit logging
-    - Environment-based safety modes
+  - Execution timeout protection
+  - Result size limiting
+  - Complete audit logging
+  - Environment-based safety modes
 - Console executor with:
-    - Output capturing
-    - Error handling
-    - Execution timing
-    - Context isolation
+  - Output capturing
+  - Error handling
+  - Execution timing
+  - Context isolation
 
 ### Security
 
@@ -125,4 +170,4 @@ For users upgrading from v1.x:
 
 - Project initialization
 - Basic gem structure
-- Initial safety checker implementation
+- Initial safety checker implementation

data/docker-compose.yml

@@ -0,0 +1,59 @@
+version: '3.8'
+
+services:
+  # Service for running tests
+  test:
+    build: .
+    volumes:
+      - .:/app
+      - bundle_cache:/usr/local/bundle
+    environment:
+      - RAILS_ENV=test
+    command: bundle exec rspec
+    stdin_open: true
+    tty: true
+
+  # Service for the MCP server (for Claude Desktop integration)
+  mcp-server:
+    build: .
+    volumes:
+      - .:/app
+      - bundle_cache:/usr/local/bundle
+    working_dir: /app
+    stdin_open: true
+    tty: false
+    command: bundle exec rails-active-mcp-server
+    environment:
+      - RAILS_ENV=development
+
+  # Service for example Rails app
+  example-app:
+    build: .
+    volumes:
+      - .:/app
+      - bundle_cache:/usr/local/bundle
+      - example_db:/app/example/db
+    working_dir: /app/example
+    ports:
+      - "3000:3000"
+    environment:
+      - RAILS_ENV=development
+    command: bundle exec rails server -b 0.0.0.0
+    stdin_open: true
+    tty: true
+
+  # Interactive shell for development
+  dev:
+    build: .
+    volumes:
+      - .:/app
+      - bundle_cache:/usr/local/bundle
+    environment:
+      - RAILS_ENV=development
+    command: bash
+    stdin_open: true
+    tty: true
+
+volumes:
+  bundle_cache:
+  example_db:

data/docs/DEBUGGING.md

@@ -204,7 +204,7 @@ bundle exec rails-active-mcp-server http --port 8080
 3. Verify server process starts: `ps aux | grep rails-active-mcp`
 4. Test basic JSON-RPC response:
    ```bash
-   echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"test","version":"1.0.0"}}}' | bundle exec rails-active-mcp-server stdio
+   echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"test","version":"1.0.0"}}}' | bundle exec rails-active-mcp-server stdio
    ```
 
 ## Logging Implementation
@@ -249,7 +249,7 @@ end
 
 ```bash
 # Test initialize method
-echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"test","version":"1.0.0"}}}' | bundle exec rails-active-mcp-server stdio
+echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"test","version":"1.0.0"}}}' | bundle exec rails-active-mcp-server stdio
 ```
 
 Expected response:
@@ -258,7 +258,7 @@ Expected response:
   "jsonrpc":"2.0",
   "id":1,
   "result": {
-    "protocolVersion":"2025-06-18",
+    "protocolVersion":"2025-11-25",
     "capabilities":{"tools":{},"resources":{}},
     "serverInfo":{"name":"rails-active-mcp","version":"..."}
   }