mcp_on_ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc959666bde188d8d9642e81879d3e16436b592a36e503e7c3d6f23dd040810b
-  data.tar.gz: ce86ed0d4ce97276435ad7192133dc8a6b613cc4974996cdd41cbabae1f15ae7
+  metadata.gz: ebcb9d413504e157ae357d8904fd719a2d5c264c2b483042e295848a91413960
+  data.tar.gz: 79f2057e8da7aefb9a093b079dc593a0d8aa786c53b1c54cec0654b485fef76f
 SHA512:
-  metadata.gz: a41b4314669cf296ff64d5d71524472da25de3ca43e8b27bfab3d1b5fdf5e2969f208c11c5b094849b648f7e1bc53ce3b51bf7c4917e4322542d026d53488d28
-  data.tar.gz: 541c892381b491280fa0c74f168782afcba411d43657686880cabd67a560a1fc34b7f8529ce0049cf3ac477209b52e134f60dcd3083aab10faa3dee311341803
+  metadata.gz: 50769ce05c60dfd97cc896f9259ef53f774f3fb4bb91accb05c37b0bba86e4829c208cd82c26367086a0ed4793b4e7dcd03d4a6074946ab5ed846cfef8715dc4
+  data.tar.gz: b34e216121ba7765d81234afcb373067f55d59dc7fe21141ca74fe3a205b0e6344d753c423f5b4fda128bf6f6d8b7af1dcea5cb0834fbc69d4f96aad669b1389

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [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,7 +1,7 @@
 <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)
@@ -11,51 +11,54 @@
 <strong>The Ruby way to build MCP servers and clients.</strong>
 </div>
 
-## Introduction
+## 🔍 Introduction
+
+The [Model Context Protocol](https://modelcontextprotocol.io) provides a standardized way for applications to interact with language models. Similar to how REST standardized web APIs, MCP creates a consistent interface for working with providers like OpenAI and Anthropic.
 
-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)
+- [💾 Custom 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,26 @@ 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
 ```
+
 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:
 
@@ -148,9 +148,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 +172,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 +316,7 @@ if response.body["tool_calls"]
 end
 ```
 
-## Rails Integration
+## 🚄 Rails Integration
 
 For Rails applications, create an initializer at `config/initializers/ruby_mcp.rb`:
 
@@ -360,8 +360,38 @@ 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.
+
 
+### Custom storage 
 You can implement custom storage backends by extending the base storage class:
 
 ```ruby
@@ -409,7 +439,7 @@ RubyMCP.configure do |config|
 end
 ```
 
-## Authentication
+## 🔒 Authentication
 
 To enable JWT authentication:
 
@@ -446,7 +476,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 +492,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
+- [ ] ActiveRecord storage backend
 - [ ] Complete test coverage, including integration tests
 - [ ] Improved error handling and recovery strategies
 - [ ] Rate limiting for provider APIs
@@ -476,7 +507,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 +517,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,15 @@
+# lib/ruby_mcp/client.rb
+# frozen_string_literal: true
+
+module RubyMCP
+  class Client
+    attr_reader :storage
+
+    def initialize(storage)
+      @storage = storage
+    end
+
+    # You can add additional convenience methods here
+    # that delegate to storage or provide higher-level functionality
+  end
+end

data/lib/ruby_mcp/configuration.rb

@@ -3,7 +3,7 @@
 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
 
     def initialize
       @providers = {}
@@ -14,6 +14,21 @@ module RubyMCP
       @jwt_secret = nil
       @token_expiry = 3600 # 1 hour
       @max_contexts = 1000
+      @storage = :memory  # Default to memory storage
+      @redis = {}         # Default empty Redis config
+    end
+
+    def storage_config
+      if @storage == :redis
+        {
+          type: :redis,
+          connection: redis_connection_config,
+          namespace: @redis[:namespace] || 'ruby_mcp',
+          ttl: @redis[:ttl] || 86_400
+        }
+      else
+        { type: @storage }
+      end
     end
 
     def storage_instance
@@ -35,5 +50,20 @@ module RubyMCP
 
                             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/storage/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RubyMCP
+  module Storage
+    # Error class for storage-related errors
+    class Error < StandardError; end
+  end
+end

data/lib/ruby_mcp/storage/redis.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'json'
+require_relative 'error'
+
+module RubyMCP
+  module Storage
+    # Redis-based storage implementation for RubyMCP
+    class Redis < Base
+      def initialize(options = {})
+        super
+        @redis = if options[:connection].is_a?(::Redis)
+                   options[:connection]
+                 elsif options[:connection].is_a?(Hash)
+                   ::Redis.new(options[:connection])
+                 else
+                   ::Redis.new
+                 end
+        @namespace = options[:namespace] || 'ruby_mcp'
+        @ttl = options[:ttl] || 86_400 # Default 1 day TTL in seconds
+      end
+
+      # Context management
+      def create_context(context)
+        # Ensure context has an ID
+        context_id = context['id']
+        raise Error, 'Context must have an ID' unless context_id
+
+        # Check if context already exists
+        raise Error, "Context with ID '#{context_id}' already exists" if get_context(context_id)
+
+        # Store the context
+        store_context(context)
+
+        # Add to index with timestamp for ordering
+        @redis.zadd(
+          contexts_index_key,
+          Time.now.to_f,
+          context_id
+        )
+
+        # Return the created context
+        context
+      end
+
+      def get_context(context_id)
+        # Get the context data
+        context_data = @redis.get(context_key(context_id))
+        return nil unless context_data
+
+        # Parse the context
+        context = JSON.parse(context_data)
+
+        # Get messages if any
+        messages = get_messages(context_id)
+        context['messages'] = messages if messages.any?
+
+        context
+      end
+
+      def update_context(context)
+        context_id = context['id']
+
+        # Check if context exists
+        raise Error, "Context with ID '#{context_id}' does not exist" unless get_context(context_id)
+
+        # Store the updated context
+        store_context(context)
+
+        context
+      end
+
+      def delete_context(context_id)
+        # Remove from index
+        @redis.zrem(contexts_index_key, context_id)
+
+        # Delete context data
+        @redis.del(context_key(context_id))
+
+        # Delete messages
+        @redis.del(messages_key(context_id))
+
+        # Delete all content (using pattern matching)
+        content_pattern = key(['context', context_id, 'content', '*'])
+        content_keys = @redis.keys(content_pattern)
+        @redis.del(*content_keys) if content_keys.any?
+
+        true
+      end
+
+      def list_contexts(limit: 100, offset: 0)
+        # Get context IDs from the index, sorted by score (timestamp) descending
+        context_ids = @redis.zrevrange(contexts_index_key, offset, offset + limit - 1)
+
+        # Return early if no contexts
+        return [] if context_ids.empty?
+
+        # Get each context
+        context_ids.map { |id| get_context(id) }.compact
+      end
+
+      # Message handling
+      def add_message(context_id, message)
+        # Ensure context exists
+        raise Error, "Context with ID '#{context_id}' does not exist" unless get_context(context_id)
+
+        # Add message to the messages list
+        message_json = JSON.generate(message)
+        @redis.rpush(messages_key(context_id), message_json)
+
+        # Set TTL on messages key
+        @redis.expire(messages_key(context_id), @ttl)
+
+        message
+      end
+
+      # Content handling
+      def add_content(context_id, content_id, content_data)
+        # Ensure context exists
+        raise Error, "Context with ID '#{context_id}' does not exist" unless get_context(context_id)
+
+        # Store content
+        key = content_key(context_id, content_id)
+
+        # If content is binary or complex, use Base64 encoding
+        if content_data.is_a?(String) &&
+           (content_data.encoding == Encoding::BINARY || content_data.include?("\0"))
+          @redis.set(key, [content_data].pack('m0'))
+          @redis.set("#{key}:encoding", 'base64')
+        else
+          @redis.set(key, content_data)
+        end
+
+        # Set TTL
+        @redis.expire(key, @ttl)
+        @redis.expire("#{key}:encoding", @ttl) if @redis.exists?("#{key}:encoding")
+
+        content_data
+      end
+
+      def get_content(context_id, content_id)
+        key = content_key(context_id, content_id)
+        content = @redis.get(key)
+        return nil unless content
+
+        # Check if we need to decode from Base64
+        encoding = @redis.get("#{key}:encoding")
+        content = content.unpack1('m0') if encoding == 'base64'
+
+        content
+      end
+
+      private
+
+      def store_context(context)
+        context_id = context['id']
+
+        # Store the context
+        context_json = JSON.generate(context)
+        @redis.set(context_key(context_id), context_json)
+
+        # Set TTL
+        @redis.expire(context_key(context_id), @ttl)
+      end
+
+      def get_messages(context_id)
+        # Get all messages from the list
+        message_jsons = @redis.lrange(messages_key(context_id), 0, -1)
+
+        # Parse each message
+        message_jsons.map { |json| JSON.parse(json) }
+      end
+
+      # Helper methods for key generation
+      def key(parts)
+        [@namespace, *parts].join(':')
+      end
+
+      def context_key(context_id)
+        key(['context', context_id])
+      end
+
+      def messages_key(context_id)
+        key(['context', context_id, 'messages'])
+      end
+
+      def content_key(context_id, content_id)
+        key(['context', context_id, 'content', content_id])
+      end
+
+      def contexts_index_key
+        key(%w[contexts index])
+      end
+    end
+  end
+end

data/lib/ruby_mcp/storage_factory.rb

@@ -0,0 +1,32 @@
+# lib/ruby_mcp/storage_factory.rb
+# frozen_string_literal: true
+
+module RubyMCP
+  class StorageFactory
+    def self.create(config)
+      # Support both old and new configuration interfaces
+      storage_config = if config.respond_to?(:storage_config)
+                         config.storage_config
+                       else
+                         config.storage
+                       end
+
+      case storage_config[:type]
+      when :memory, nil
+        Storage::Memory.new(storage_config)
+      when :redis
+        # Load Redis dependencies
+        begin
+          require 'redis'
+          require_relative 'storage/redis'
+        rescue LoadError => e
+          raise LoadError, "Redis storage requires the redis gem. Add it to your Gemfile: #{e.message}"
+        end
+
+        Storage::Redis.new(storage_config)
+      else
+        raise ArgumentError, "Unknown storage type: #{storage_config[:type]}"
+      end
+    end
+  end
+end

data/lib/ruby_mcp/version.rb

@@ -2,5 +2,5 @@
 
 # lib/ruby_mcp/version.rb
 module RubyMCP
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/ruby_mcp.rb

@@ -33,11 +33,20 @@ require_relative 'ruby_mcp/providers/anthropic'
 require_relative 'ruby_mcp/schemas'
 require_relative 'ruby_mcp/validator'
 
+require_relative 'ruby_mcp/client'
+
 module RubyMCP
   class << self
     attr_accessor :configuration
     attr_writer :logger
 
+    def client
+      @client ||= begin
+        initialize_components unless @storage
+        Client.new(@storage)
+      end
+    end
+
     def configure
       self.configuration ||= Configuration.new
       yield(configuration) if block_given?
@@ -48,5 +57,12 @@ module RubyMCP
         log.progname = name
       end
     end
+
+    private
+
+    def initialize_components
+      require_relative 'ruby_mcp/storage_factory'
+      @storage = StorageFactory.create(configuration)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mcp_on_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 2025-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +235,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/ruby_mcp.rb
+- lib/ruby_mcp/client.rb
 - lib/ruby_mcp/configuration.rb
 - lib/ruby_mcp/errors.rb
 - lib/ruby_mcp/models/context.rb
@@ -240,7 +255,10 @@ files:
 - lib/ruby_mcp/server/messages_controller.rb
 - lib/ruby_mcp/server/router.rb
 - lib/ruby_mcp/storage/base.rb
+- lib/ruby_mcp/storage/error.rb
 - lib/ruby_mcp/storage/memory.rb
+- lib/ruby_mcp/storage/redis.rb
+- lib/ruby_mcp/storage_factory.rb
 - lib/ruby_mcp/validator.rb
 - lib/ruby_mcp/version.rb
 homepage: https://github.com/nagstler/mcp_on_ruby
@@ -267,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.2
 signing_key:
 specification_version: 4
 summary: Ruby implementation of the Model Context Protocol (MCP)