mcp_on_ruby 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc959666bde188d8d9642e81879d3e16436b592a36e503e7c3d6f23dd040810b
-  data.tar.gz: ce86ed0d4ce97276435ad7192133dc8a6b613cc4974996cdd41cbabae1f15ae7
+  metadata.gz: 04166e9711a0a9c233c43a2f1bba53b27d0a716a7cc996c52f597433e559909d
+  data.tar.gz: 588bbbd27e9bc620e4cf4ea14b97b4e8c5cd869b672f8956a2a17b16b179afdb
 SHA512:
-  metadata.gz: a41b4314669cf296ff64d5d71524472da25de3ca43e8b27bfab3d1b5fdf5e2969f208c11c5b094849b648f7e1bc53ce3b51bf7c4917e4322542d026d53488d28
-  data.tar.gz: 541c892381b491280fa0c74f168782afcba411d43657686880cabd67a560a1fc34b7f8529ce0049cf3ac477209b52e134f60dcd3083aab10faa3dee311341803
+  metadata.gz: c22a5a6e40162c8754975bb89288ee5147314e41564a97ea25ab7b85fae03eecfcdc7246a0567520d6813ead8bc22e88ffcfa265ccf16653c2da8f06da8adb28
+  data.tar.gz: e16b57bd9c57d50f1f9f46328d29b94986e54785b166cbf321db1d06366fcd0fa2d43dd7206468ac3671219be7800c8a1f8ccbaaea2eaa77ca4e95217c32da2f

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [0.3.0] - 2023-05-01
+
+### Added
+- ActiveRecord storage backend for database persistence
+- Support for Rails integration with ActiveRecord storage
+- Auto-creation of database tables with configurable prefixes
+- Proper handling of different data types (text, binary, JSON)
+- Symbolization of hash keys for consistent API
+- Comprehensive test suite for ActiveRecord storage
+
+### Changed
+- Enhanced `StorageFactory` to support ActiveRecord backend
+- Updated configuration system with ActiveRecord options
+- Improved documentation with ActiveRecord storage examples
+
+## [0.2.0] - 2025-04-21
+
+### Added
+- Redis storage backend with comprehensive test coverage
+- Configurable TTL and namespace support for Redis keys
+- Rails integration with Redis storage examples
+- Wiki documentation for Redis storage setup and usage
+
+### Changed
+- Enhanced storage factory to support different backend types
+- Improved configuration API for more intuitive setup
+- Updated README with Redis storage documentation
+
 ## [0.1.0] - 2025-04-18
 
 Initial release of version 0.1.0 of the Ruby Gem. 

data/README.md

@@ -1,61 +1,64 @@
 <div align="center">
 
-# RubyMCP
-
+# MCP on Ruby
+[![Gem Version](https://badge.fury.io/rb/mcp_on_ruby.svg)](https://badge.fury.io/rb/mcp_on_ruby)
 [![Build](https://github.com/nagstler/ruby_mcp/actions/workflows/build.yml/badge.svg)](https://github.com/nagstler/ruby_mcp/actions/workflows/build.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![RuboCop](https://github.com/nagstler/ruby_mcp/actions/workflows/rubocop.yml/badge.svg)](https://github.com/nagstler/ruby_mcp/actions/workflows/rubocop.yml)
 [![Test](https://github.com/nagstler/ruby_mcp/actions/workflows/test.yml/badge.svg)](https://github.com/nagstler/ruby_mcp/actions/workflows/test.yml)
 [![codecov](https://codecov.io/github/nagstler/ruby_mcp/graph/badge.svg?token=SG4EJEIHW3)](https://codecov.io/github/nagstler/ruby_mcp)
 
-<strong>The Ruby way to build MCP servers and clients.</strong>
+<strong> **Turn your Rails APIs into an MCP server.**</strong> 
+
 </div>
 
-## Introduction
+## 🔍 Introduction
+The [Model Context Protocol](https://modelcontextprotocol.io) standardizes how applications interact with AI models, serving as the "REST for LLMs." **MCP on Ruby** brings this standard to the Ruby ecosystem. Create contexts, manage conversations, connect to multiple providers, and handle streaming responses with clean, Ruby code.
 
-The [Model Context Protocol (MCP)](https://modelcontextprotocol.io) provides a standardized way for applications to interact with various language model providers (like OpenAI, Anthropic, etc.) through a consistent interface.
+![System Component Flow (Horizontal)](https://github.com/user-attachments/assets/085ad9b8-bee0-4d60-a4b7-ecf02d07f53c)
 
-![design-1](https://github.com/user-attachments/assets/c1d76dc9-6aea-4cbb-a779-f0f7d85e71fb)
+> 📌 If you find this useful, **give it a ⭐ on GitHub**
 
-## Table of Contents
+## 📋 Table of Contents
 
-- [Introduction](#introduction)
-- [Why RubyMCP?](#why-rubymcp)
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-  - [Interactive Demo](#interactive-demo)
-- [Configuration Options](#configuration-options)
-- [Server Endpoints](#server-endpoints)
-- [Detailed Usage](#detailed-usage)
+- [🔍 Introduction](#-introduction)
+- [🌟 Why MCP on Ruby?](#-why-mcp-on-ruby)
+- [📦 Installation](#-installation)
+- [🚀 Quick Start](#-quick-start)
+  - [🎮 Interactive Demo](#-interactive-demo)
+- [⚙️ Configuration Options](#️-configuration-options)
+- [🛣️ Server Endpoints](#️-server-endpoints)
+- [📚 Detailed Usage](#-detailed-usage)
   - [Creating a Context](#creating-a-context)
   - [Adding a Message](#adding-a-message)
   - [Generating a Response](#generating-a-response)
   - [Streaming a Response](#streaming-a-response)
   - [Uploading Content](#uploading-content)
   - [Using Tool Calls](#using-tool-calls)
-- [Rails Integration](#rails-integration)
-- [Custom Storage Backend](#custom-storage-backend)
-- [Authentication](#authentication)
-- [Development](#development)
-- [Roadmap](#roadmap)
-- [Contributing](#contributing)
-- [License](#license)
-
-## Why RubyMCP?
-
-RubyMCP provides a Ruby implementation of the Model Context Protocol:
-
-- Standard API for multiple LLM providers
-- Context management for conversations
-- Support for streaming responses
-- File handling capabilities
-- Tool calling support
-- Authentication
-- Schema validation using dry-schema
+- [🚄 Rails Integration](#-rails-integration)
+- [💾 Storage Backend](#-storage-backends)
+- [🔒 Authentication](#-authentication)
+- [🛠️ Development](#️-development)
+- [🗺️ Roadmap](#️-roadmap)
+- [👥 Contributing](#-contributing)
+- [📄 License](#-license)
+
+## 🌟 Why MCP on Ruby?
+
+**MCP on Ruby** provides a comprehensive implementation of the Model Context Protocol with these features:
+
+- **Provider-Ready:** Pre-built adapters for OpenAI and Anthropic - just add your API key
+- **Complete Protocol Implementation:** Fully implements the MCP specification for compatibility
+- **Conversation Management:** Context handling for multi-turn conversations
+- **Flexible Storage:** Extensible storage backends
+- **Streaming Support:** Real-time response streaming for dynamic UIs
+- **File Handling:** Upload and reference files in conversations
+- **Tool Calling:** Support for LLM function calling capabilities
+- **Battle-Tested:** Comprehensive test suite ensures reliability
 
 The library is designed to be straightforward to use while maintaining full compatibility with the MCP specification.
 
-## Installation
+## 📦 Installation
 
 Add this line to your application's Gemfile:
 
@@ -75,7 +78,7 @@ Or install it yourself as:
 $ gem install mcp_on_ruby
 ```
 
-## Quick Start
+## 🚀 Quick Start
 
 Here's how to get a basic MCP server running:
 
@@ -92,29 +95,31 @@ end
 
 # Start the MCP server
 server = RubyMCP::Server::Controller.new
-server.start  # This will block the current thread
+server.start
 ```
 
-### Interactive Demo
+### 🎮 Interactive Demo
 
 The repository includes an interactive demo that walks through all the key MCP concepts:
 
-First, start the example server:
-
 ```bash
+# Terminal 1: Start the server
 cd examples/simple_server
 ruby server.rb
-```
-
-Then, in a separate terminal, run the client:
 
-```bash
+# Terminal 2: Run the client
 cd examples/simple_server
 ruby client.rb
+
+# ActiveRecord Storage Demo
+# Demonstrates database storage with SQLite
+cd examples/simple_server
+ruby activerecord_demo.rb
 ```
+
 This demo provides a guided tour of the MCP functionality, showing each step of creating contexts, adding messages, and generating responses with detailed explanations.
 
-## Configuration Options
+## ⚙️ Configuration Options
 
 RubyMCP offers several configuration options:
 
@@ -131,9 +136,31 @@ RubyMCP.configure do |config|
     }
   }
   
-  # Storage backend (:memory, :redis, :active_record, or custom)
+  # Storage backend
+  
+  # Option 1: Memory storage (default)
   config.storage = :memory
   
+  # Option 2: Redis storage
+  config.storage = :redis
+  config.redis = {
+    url: ENV.fetch('REDIS_URL', 'redis://localhost:6379/0'),
+    namespace: 'my_app_mcp',
+    ttl: 86400 # 1 day in seconds
+  }
+  
+  # Option 3: ActiveRecord storage
+  config.storage = :active_record
+  config.active_record = {
+    # Connection settings (not needed in Rails)
+    connection: {
+      adapter: 'sqlite3',
+      database: 'db/mcp.sqlite3'
+    },
+    # Table prefix to avoid name collisions
+    table_prefix: 'mcp_'
+  }
+  
   # Server settings
   config.server_port = 3000
   config.server_host = "0.0.0.0"
@@ -148,9 +175,9 @@ RubyMCP.configure do |config|
 end
 ```
 
-## Server Endpoints
+## 🛣️ Server Endpoints
 
-The MCP server provides the following endpoints:
+The MCP server provides the following RESTful endpoints:
 
 ### Engines
 - `GET /engines` - List available language models
@@ -172,7 +199,7 @@ The MCP server provides the following endpoints:
 - `POST /content` - Upload content (files)
 - `GET /content/:context_id/:id` - Retrieve uploaded content
 
-## Detailed Usage
+## 📚 Detailed Usage
 
 ### Creating a Context
 
@@ -316,7 +343,7 @@ if response.body["tool_calls"]
 end
 ```
 
-## Rails Integration
+## 🚄 Rails Integration
 
 For Rails applications, create an initializer at `config/initializers/ruby_mcp.rb`:
 
@@ -331,7 +358,11 @@ RubyMCP.configure do |config|
   if Rails.env.development? || Rails.env.test?
     config.storage = :memory
   else
-    config.storage = :memory  # Replace with persistent option when implemented
+    # Use ActiveRecord for production (uses your Rails database)
+    config.storage = :active_record
+    config.active_record = {
+      table_prefix: "mcp_#{Rails.env}_"  # Environment-specific prefix
+    }
   end
   
   # Enable authentication in production
@@ -360,8 +391,75 @@ Rails.application.routes.draw do
 end
 ```
 
-## Custom Storage Backend
+## 💾 Storage Backends
+
+### Redis Storage
+
+MCP on Ruby supports Redis as a persistent storage backend:
+
+1. Add the Redis gem to your Gemfile:
+   ```ruby
+   gem 'redis', '~> 5.0'
+   ```
+
+2. Configure Redis storage:
+   ```ruby
+   RubyMCP.configure do |config|
+     config.storage = :redis
+     config.redis = {
+       url: ENV.fetch('REDIS_URL', 'redis://localhost:6379/0'),
+       namespace: "app_mcp_#{Rails.env}",
+       ttl: 86400  # 1 day in seconds
+     }
+   end
+   ```
+
+3. Access the configured client:
+   ```ruby
+   client = RubyMCP.client
+   ```
+
+For detailed integration examples, see the [[Redis Storage](https://github.com/nagstler/mcp_on_ruby/wiki/Redis-Storage)] wiki page.
+
+### ActiveRecord Storage
+
+For integration with Rails or any app needing database storage:
+
+```ruby
+# Add to Gemfile
+gem 'activerecord', '~> 6.1'
+gem 'sqlite3', '~> 1.4'  # or pg, mysql2, etc.
+
+# Configure RubyMCP
+RubyMCP.configure do |config|
+  config.storage = :active_record
+  config.active_record = {
+    # Connection (not needed in Rails)
+    connection: {
+      adapter: 'sqlite3',
+      database: 'db/mcp.sqlite3'
+    },
+    # Table prefix to avoid name collisions
+    table_prefix: 'mcp_'
+  }
+end
+```
+
+In Rails applications, it uses your app's database connection automatically:
+
+```ruby
+# config/initializers/ruby_mcp.rb
+RubyMCP.configure do |config|
+  config.storage = :active_record
+  config.active_record = {
+    table_prefix: "mcp_#{Rails.env}_"  # Environment-specific prefix
+  }
+end
+```
+
+The ActiveRecord adapter automatically creates the necessary tables with appropriate indexes, and handles different types of data (text, binary, JSON) appropriately.
 
+### Custom storage 
 You can implement custom storage backends by extending the base storage class:
 
 ```ruby
@@ -409,7 +507,7 @@ RubyMCP.configure do |config|
 end
 ```
 
-## Authentication
+## 🔒 Authentication
 
 To enable JWT authentication:
 
@@ -446,7 +544,7 @@ conn.get("http://localhost:3000/contexts") do |req|
 end
 ```
 
-## Development
+## 🛠️ Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
@@ -462,11 +560,12 @@ bundle exec rspec
 bundle exec ruby examples/simple_server/server.rb
 ```
 
-## Roadmap
+## 🗺️ Roadmap
 
 While RubyMCP is functional for basic use cases, there are several areas planned for improvement:
 
-- [ ] Persistent storage backends (Redis, ActiveRecord)
+- [x] Redis persistent storage backend
+- [x] ActiveRecord storage backend
 - [ ] Complete test coverage, including integration tests
 - [ ] Improved error handling and recovery strategies
 - [ ] Rate limiting for provider APIs
@@ -476,7 +575,7 @@ While RubyMCP is functional for basic use cases, there are several areas planned
 
 :heart: Contributions in any of these areas are welcome!
 
-## Contributing
+## 👥 Contributing
 
 1. Fork the repository
 2. Create your feature branch (`git checkout -b feature/my-new-feature`)
@@ -486,6 +585,6 @@ While RubyMCP is functional for basic use cases, there are several areas planned
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nagstler/mcp_on_ruby.
 
-## License
+## 📄 License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ruby_mcp/client.rb

@@ -0,0 +1,43 @@
+# lib/ruby_mcp/client.rb
+# frozen_string_literal: true
+
+module RubyMCP
+  class Client
+    attr_reader :storage
+
+    def initialize(storage)
+      @storage = storage
+    end
+
+    def create_context(messages = [], metadata = {})
+      context = RubyMCP::Models::Context.new(messages: messages, metadata: metadata)
+      storage.create_context(context)
+    end
+
+    def list_contexts(limit: 50, offset: 0)
+      storage.list_contexts(limit: limit, offset: offset)
+    end
+
+    def get_context(context_id)
+      storage.get_context(context_id)
+    end
+
+    def delete_context(context_id)
+      storage.delete_context(context_id)
+    end
+
+    def add_message(context_id, role, content, metadata: {})
+      message = RubyMCP::Models::Message.new(role: role, content: content, metadata: metadata)
+      storage.add_message(context_id, message)
+    end
+
+    def add_content(context_id, content_data, content_id = nil)
+      content_id ||= "cnt_#{SecureRandom.hex(10)}"
+      storage.add_content(context_id, content_id, content_data)
+    end
+
+    def get_content(context_id, content_id)
+      storage.get_content(context_id, content_id)
+    end
+  end
+end

data/lib/ruby_mcp/configuration.rb

@@ -3,7 +3,8 @@
 module RubyMCP
   class Configuration
     attr_accessor :providers, :storage, :server_port, :server_host,
-                  :auth_required, :jwt_secret, :token_expiry, :max_contexts
+                  :auth_required, :jwt_secret, :token_expiry, :max_contexts,
+                  :redis, :active_record
 
     def initialize
       @providers = {}
@@ -14,6 +15,28 @@ module RubyMCP
       @jwt_secret = nil
       @token_expiry = 3600 # 1 hour
       @max_contexts = 1000
+      @redis = {}         # Default empty Redis config
+      @active_record = {} # Default empty ActiveRecord config
+    end
+
+    def storage_config
+      case @storage
+      when :redis
+        {
+          type: :redis,
+          connection: redis_connection_config,
+          namespace: @redis[:namespace] || 'ruby_mcp',
+          ttl: @redis[:ttl] || 86_400
+        }
+      when :active_record
+        {
+          type: :active_record,
+          connection: @active_record[:connection],
+          table_prefix: @active_record[:table_prefix] || 'mcp_'
+        }
+      else
+        { type: @storage }
+      end
     end
 
     def storage_instance
@@ -21,19 +44,47 @@ module RubyMCP
                             when :memory
                               RubyMCP::Storage::Memory.new
                             when :redis
-                              # Future implementation
-                              raise RubyMCP::Errors::ConfigurationError, 'Redis storage not yet implemented'
+                              begin
+                                require 'redis'
+                                require_relative 'storage/redis'
+                                RubyMCP::Storage::Redis.new(storage_config)
+                              rescue LoadError
+                                raise RubyMCP::Errors::ConfigurationError,
+                                      "Redis storage requires the redis gem. Add it to your Gemfile with:
+                                      gem 'redis', '~> 5.0'"
+                              end
                             when :active_record
-                              # Future implementation
-                              raise RubyMCP::Errors::ConfigurationError, 'ActiveRecord storage not yet implemented'
+                              begin
+                                require 'active_record'
+                                require_relative 'storage/active_record'
+                                RubyMCP::Storage::ActiveRecord.new(storage_config)
+                              rescue LoadError
+                                raise RubyMCP::Errors::ConfigurationError,
+                                      "ActiveRecord storage requires the activerecord gem. Add it to your Gemfile with:
+                                      gem 'activerecord', '~> 6.0'"
+                              end
                             else
                               unless @storage.is_a?(RubyMCP::Storage::Base)
                                 raise RubyMCP::Errors::ConfigurationError, "Unknown storage type: #{@storage}"
                               end
 
                               @storage # Allow custom storage instance
-
                             end
     end
+
+    private
+
+    def redis_connection_config
+      if @redis[:url]
+        { url: @redis[:url] }
+      else
+        {
+          host: @redis[:host] || 'localhost',
+          port: @redis[:port] || 6379,
+          db: @redis[:db] || 0,
+          password: @redis[:password]
+        }.compact
+      end
+    end
   end
 end

data/lib/ruby_mcp/models/context.rb

@@ -37,6 +37,7 @@ module RubyMCP
         {
           id: @id,
           messages: @messages.map(&:to_h),
+          content_map: @content_map,
           created_at: @created_at.iso8601,
           updated_at: @updated_at.iso8601,
           metadata: @metadata

data/lib/ruby_mcp/server/contexts_controller.rb

@@ -53,10 +53,14 @@ module RubyMCP
       end
 
       def destroy
-        context = storage.delete_context(params[:id])
-        ok(context.to_h)
-      rescue RubyMCP::Errors::ContextError => e
-        not_found(e.message)
+        context_id = params[:id]
+
+        begin
+          storage.delete_context(context_id)
+          ok({ success: true })
+        rescue RubyMCP::Errors::ContextError => e
+          not_found("Context not found: #{e.message}")
+        end
       end
     end
   end