actionmcp 0.29.0 → 0.30.0

data/lib/action_mcp/configuration.rb

@@ -21,7 +21,12 @@ module ActionMCP
                   :resources_subscribe,
                   :logging_level,
                   :active_profile,
-                  :profiles
+                  :profiles,
+                  # --- New Transport Options ---
+                  :allow_client_session_termination,
+                  :mcp_endpoint_path,
+                  :sse_heartbeat_interval,
+                  :post_response_preference # :json or :sse
 
     def initialize
       @logging_enabled = true
@@ -30,6 +35,11 @@ module ActionMCP
       @resources_subscribe = false
       @active_profile = :primary
       @profiles = default_profiles
+
+      @allow_client_session_termination = true
+      @mcp_endpoint_path = "/mcp"
+      @sse_heartbeat_interval = 30
+      @post_response_preference = :json
     end
 
     def name
@@ -58,7 +68,7 @@ module ActionMCP
 
         # Merge with defaults so user config overrides gem defaults
         @profiles = app_config
-      rescue => e
+      rescue StandardError
         # If the config file doesn't exist in the Rails app, just use the defaults
         Rails.logger.debug "No MCP config found in Rails app, using defaults from gem"
       end
@@ -114,21 +124,13 @@ module ActionMCP
       capabilities = {}
 
       # Only include capabilities if the corresponding filtered registry is non-empty
-      if filtered_tools.any?
-        capabilities[:tools] = { listChanged: @list_changed }
-      end
+      capabilities[:tools] = { listChanged: @list_changed } if filtered_tools.any?
 
-      if filtered_prompts.any?
-        capabilities[:prompts] = { listChanged: @list_changed }
-      end
+      capabilities[:prompts] = { listChanged: @list_changed } if filtered_prompts.any?
 
-      if @logging_enabled
-        capabilities[:logging] = {}
-      end
+      capabilities[:logging] = {} if @logging_enabled
 
-      if filtered_resources.any?
-        capabilities[:resources] = { subscribe: @resources_subscribe }
-      end
+      capabilities[:resources] = { subscribe: @resources_subscribe } if filtered_resources.any?
 
       capabilities
     end
@@ -178,7 +180,7 @@ module ActionMCP
 
       items = @profiles[active_profile][type]
       # Return true ONLY if items contains "all"
-      items && items.include?("all")
+      items&.include?("all")
     end
 
     def has_rails_version
@@ -213,7 +215,7 @@ module ActionMCP
       thread_profiles.value = profile_name
 
       # Apply the profile options when switching profiles
-      configuration.apply_profile_options if configuration
+      configuration&.apply_profile_options
 
       yield if block_given?
     ensure

data/lib/action_mcp/server/capabilities.rb

@@ -3,17 +3,52 @@
 module ActionMCP
   module Server
     module Capabilities
+      # Handles the 'initialize' request. Validates parameters, checks protocol version,
+      # stores client info, initializes the session, and returns the server capabilities payload
+      # or an error payload.
+      # @param request_id [String, Integer] The JSON-RPC request ID.
+      # @param params [Hash] The JSON-RPC parameters.
+      # @return [Hash] A hash representing the JSON-RPC response (success or error).
       def send_capabilities(request_id, params = {})
-        # TODO: fix this if client send incorrect params
-        # TODO refuse connection if protocol version is not supported
-        @protocol_version = params["protocolVersion"]
-        @client_info = params["clientInfo"]
-        @client_capabilities = params["capabilities"]
-        session.store_client_info(@client_info)
-        session.store_client_capabilities(@client_capabilities)
-        session.set_protocol_version(@protocol_version)
-        session.initialize!
-        # TODO: , if the server don't support the protocol version, send a response with error
+        # 1. Validate Parameters
+        client_protocol_version = params["protocolVersion"]
+        client_info = params["clientInfo"]
+        client_capabilities = params["capabilities"]
+
+        unless client_protocol_version.is_a?(String) && client_protocol_version.present?
+          return send_jsonrpc_error(request_id, :invalid_params, "Missing or invalid 'protocolVersion'")
+        end
+        # Basic check, could be more specific based on spec requirements
+        unless client_info.is_a?(Hash)
+          return send_jsonrpc_error(request_id, :invalid_params, "Missing or invalid 'clientInfo'")
+        end
+        unless client_capabilities.is_a?(Hash)
+          return send_jsonrpc_error(request_id, :invalid_params, "Missing or invalid 'capabilities'")
+        end
+
+        # 2. Check Protocol Version
+        server_protocol_version = ActionMCP::PROTOCOL_VERSION
+        unless client_protocol_version == server_protocol_version
+          error_data = {
+            supported: [ server_protocol_version ],
+            requested: client_protocol_version
+          }
+          # Using -32602 Invalid Params code as per spec example for version mismatch
+          return send_jsonrpc_error(request_id, :invalid_params, "Unsupported protocol version", error_data)
+        end
+
+        # 3. Store Info and Initialize Session
+        session.store_client_info(client_info)
+        session.store_client_capabilities(client_capabilities)
+        session.set_protocol_version(client_protocol_version) # Store the agreed-upon version
+
+        # Attempt to initialize (this saves the session if new)
+        unless session.initialize!
+          # Handle potential initialization failure (e.g., validation error on save)
+          return send_jsonrpc_error(request_id, :internal_error, "Failed to initialize session")
+        end
+
+        # 4. Return Success Response Payload
         send_jsonrpc_response(request_id, result: session.server_capabilities_payload)
       end
     end

data/lib/action_mcp/server/messaging.rb

@@ -16,7 +16,7 @@ module ActionMCP
       end
 
       def send_jsonrpc_error(request_id, symbol, message, data = nil)
-        error = JsonRpc::JsonRpcError.new(symbol, message: message, data: data)
+        error = JSON_RPC::JsonRpcError.new(symbol, message: message, data: data)
         send_jsonrpc_response(request_id, error: error)
       end
 
@@ -26,19 +26,19 @@ module ActionMCP
       def send_message(type, **args)
         message = case type
         when :request
-                    JsonRpc::Request.new(
+                    JSON_RPC::Request.new(
                       id: args[:id],
                       method: args[:method],
                       params: args[:params]
                     )
         when :response
-                    JsonRpc::Response.new(
+                    JSON_RPC::Response.new(
                       id: args[:id],
                       result: args[:result],
                       error: args[:error]
                     )
         when :notification
-                    JsonRpc::Notification.new(
+                    JSON_RPC::Notification.new(
                       method: args[:method],
                       params: args[:params]
                     )

data/lib/action_mcp/sse_listener.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "concurrent/atomic/atomic_boolean"
+require "concurrent/promise"
+
+module ActionMCP
+  # Listener class to subscribe to session messages via Action Cable adapter.
+  # Used by controllers handling Server-Sent Events streams.
+  class SSEListener
+    attr_reader :session_key, :adapter
+
+    delegate :session_key, :adapter, to: :@session
+
+    # @param session [ActionMCP::Session]
+    def initialize(session)
+      @session = session
+      @stopped = Concurrent::AtomicBoolean.new(false)
+      @subscription_active = Concurrent::AtomicBoolean.new(false)
+    end
+
+    # Start listening using ActionCable's adapter
+    # @yield [Hash] Yields parsed message received from the pub/sub channel
+    # @return [Boolean] True if subscription was successful within timeout, false otherwise.
+    def start(&callback)
+      Rails.logger.debug "SSEListener: Starting for channel: #{session_key}"
+
+      success_callback = lambda {
+        Rails.logger.info "SSEListener: Successfully subscribed to channel: #{session_key}"
+        @subscription_active.make_true
+      }
+
+      # Set up message callback
+      message_callback = lambda { |raw_message|
+        return if @stopped.true?
+
+        begin
+          # Try to parse the message if it's JSON
+          message = MultiJson.load(raw_message)
+          # Send the message to the callback
+          # TODO: Add SSE event ID here if implementing resumability
+          callback&.call(message)
+        rescue StandardError => e
+          Rails.logger.error "SSEListener: Error processing message: #{e.message}"
+          # Still try to send the raw message as a fallback? Or ignore?
+          # callback.call(raw_message) if callback
+        end
+      }
+
+      # Subscribe using the ActionCable adapter
+      adapter.subscribe(session_key, message_callback, success_callback)
+
+      # Use a future with timeout to check subscription status
+      subscription_future = Concurrent::Promises.future do
+        sleep 0.1 while !@subscription_active.true? && !@stopped.true?
+        @subscription_active.true?
+      end
+
+      # Wait up to 5 seconds for subscription to be established (increased timeout)
+      begin
+        subscription_result = subscription_future.value(5)
+        subscription_result || @subscription_active.true?
+      rescue Concurrent::TimeoutError
+        Rails.logger.warn "SSEListener: Timed out waiting for subscription activation for #{session_key}"
+        false
+      end
+    end
+
+    # Stops the listener and attempts to unsubscribe.
+    def stop
+      return if @stopped.true? # Prevent multiple stops
+
+      @stopped.make_true
+      # Unsubscribe using the adapter
+      # Note: ActionCable adapters might not have a direct 'unsubscribe' matching this pattern.
+      # We rely on closing the connection and potentially session cleanup.
+      # If using Redis adapter, explicit unsubscribe might be possible/needed.
+      # For now, just log.
+      Rails.logger.debug "SSEListener: Stopping listener for channel: #{session_key}"
+      # If session cleanup is needed when listener stops, add it here or ensure it happens elsewhere.
+      # Example: @session.close! if @session.role == 'server' # Be careful with side effects
+    end
+  end
+end

data/lib/action_mcp/version.rb

@@ -2,7 +2,7 @@
 
 require_relative "gem_version"
 module ActionMCP
-  VERSION = "0.29.0"
+  VERSION = "0.30.0"
 
   class << self
     alias version gem_version

data/lib/action_mcp.rb

@@ -6,6 +6,7 @@ require "active_support/rails"
 require "multi_json"
 require "concurrent"
 require "active_record/railtie"
+require "jsonrpc-rails"
 require "action_controller/railtie"
 require "action_cable/engine"
 require "action_mcp/configuration"
@@ -26,6 +27,7 @@ Zeitwerk::Loader.for_gem.tap do |loader|
   loader.inflector.inflect("action_mcp" => "ActionMCP")
   loader.inflector.inflect("sse_client" => "SSEClient")
   loader.inflector.inflect("sse_server" => "SSEServer")
+  loader.inflector.inflect("sse_listener" => "SSEListener")
 end.setup
 
 module ActionMCP
@@ -86,7 +88,3 @@ module ActionMCP
   ActiveModel::Type.register(:string_array, StringArray)
   ActiveModel::Type.register(:integer_array, IntegerArray)
 end
-
-ActiveSupport.on_load(:action_mcp, run_once: true) do
-  self.logger = ::Rails.logger
-end

data/lib/tasks/action_mcp_tasks.rake

@@ -51,7 +51,7 @@ namespace :action_mcp do
 
   # bin/rails action_mcp:show_profile[profile_name]
   desc "Show configuration for a specific profile"
-  task :show_profile, [ :profile_name ] => :environment do |t, args|
+  task :show_profile, [ :profile_name ] => :environment do |_t, args|
     # Ensure Rails eager loads all classes
     Rails.application.eager_load!
 
@@ -68,19 +68,19 @@ namespace :action_mcp do
     ActionMCP.with_profile(profile_name) do
       profile_config = profiles[profile_name]
 
-      puts "\e[35mPROFILE: #{profile_name.to_s.upcase}\e[0m"  # Purple
+      puts "\e[35mPROFILE: #{profile_name.to_s.upcase}\e[0m" # Purple
       puts "\e[35m#{'-' * (profile_name.to_s.length + 9)}\e[0m"
 
       # Show options
       if profile_config[:options]
-        puts "\n\e[36mOptions:\e[0m"  # Cyan
+        puts "\n\e[36mOptions:\e[0m" # Cyan
         profile_config[:options].each do |key, value|
           puts "  #{key}: #{value}"
         end
       end
 
       # Show Tools
-      puts "\n\e[34mIncluded Tools:\e[0m"  # Blue
+      puts "\n\e[34mIncluded Tools:\e[0m" # Blue
       if ActionMCP.configuration.filtered_tools.any?
         ActionMCP.configuration.filtered_tools.each do |tool|
           puts "  \e[34m#{tool.name}:\e[0m #{tool.description}"
@@ -90,7 +90,7 @@ namespace :action_mcp do
       end
 
       # Show Prompts
-      puts "\n\e[32mIncluded Prompts:\e[0m"  # Green
+      puts "\n\e[32mIncluded Prompts:\e[0m" # Green
       if ActionMCP.configuration.filtered_prompts.any?
         ActionMCP.configuration.filtered_prompts.each do |prompt|
           puts "  \e[32m#{prompt.name}:\e[0m #{prompt.description}"
@@ -100,7 +100,7 @@ namespace :action_mcp do
       end
 
       # Show Resources
-      puts "\n\e[33mIncluded Resources:\e[0m"  # Yellow
+      puts "\n\e[33mIncluded Resources:\e[0m" # Yellow
       if ActionMCP.configuration.filtered_resources.any?
         ActionMCP.configuration.filtered_resources.each do |resource|
           puts "  \e[33m#{resource.name}:\e[0m #{resource.description}"
@@ -110,7 +110,7 @@ namespace :action_mcp do
       end
 
       # Show Capabilities
-      puts "\n\e[36mActive Capabilities:\e[0m"  # Cyan
+      puts "\n\e[36mActive Capabilities:\e[0m" # Cyan
       capabilities = ActionMCP.configuration.capabilities
       capabilities.each do |cap_name, cap_config|
         puts "  #{cap_name}: #{cap_config.inspect}"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: actionmcp
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable
@@ -80,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: jsonrpc-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: It offers base classes and helpers for creating MCP applications, making
   it easier to integrate your Ruby/Rails application with the MCP standard
 email:
@@ -95,6 +108,7 @@ files:
 - app/controllers/action_mcp/mcp_controller.rb
 - app/controllers/action_mcp/messages_controller.rb
 - app/controllers/action_mcp/sse_controller.rb
+- app/controllers/action_mcp/unified_controller.rb
 - app/models/action_mcp.rb
 - app/models/action_mcp/application_record.rb
 - app/models/action_mcp/session.rb
@@ -107,6 +121,7 @@ files:
 - db/migrate/20250316005021_create_action_mcp_session_subscriptions.rb
 - db/migrate/20250316005649_create_action_mcp_session_resources.rb
 - db/migrate/20250324203409_remove_session_message_text.rb
+- db/migrate/20250327124131_add_sse_event_counter_to_action_mcp_sessions.rb
 - exe/actionmcp_cli
 - lib/action_mcp.rb
 - lib/action_mcp/base_response.rb
@@ -142,11 +157,6 @@ files:
 - lib/action_mcp/instrumentation/instrumentation.rb
 - lib/action_mcp/instrumentation/resource_instrumentation.rb
 - lib/action_mcp/integer_array.rb
-- lib/action_mcp/json_rpc.rb
-- lib/action_mcp/json_rpc/json_rpc_error.rb
-- lib/action_mcp/json_rpc/notification.rb
-- lib/action_mcp/json_rpc/request.rb
-- lib/action_mcp/json_rpc/response.rb
 - lib/action_mcp/json_rpc_handler_base.rb
 - lib/action_mcp/log_subscriber.rb
 - lib/action_mcp/logging.rb
@@ -171,6 +181,7 @@ files:
 - lib/action_mcp/server/sampling_request.rb
 - lib/action_mcp/server/tools.rb
 - lib/action_mcp/server/transport_handler.rb
+- lib/action_mcp/sse_listener.rb
 - lib/action_mcp/string_array.rb
 - lib/action_mcp/test_helper.rb
 - lib/action_mcp/tool.rb
@@ -200,7 +211,6 @@ metadata:
   source_code_uri: https://github.com/seuros/action_mcp
   changelog_uri: https://github.com/seuros/action_mcp/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,8 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Provides essential tooling for building Model Context Protocol (MCP) capable
   servers

data/lib/action_mcp/json_rpc/json_rpc_error.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module ActionMCP
-  module JsonRpc
-    # Custom exception class for JSON-RPC errors, based on the JSON-RPC 2.0 specification.
-    class JsonRpcError < StandardError
-      # Define the standard JSON-RPC 2.0 error codes
-      ERROR_CODES = {
-        parse_error: {
-          code: -32_700,
-          message: "Parse error"
-        },
-        invalid_request: {
-          code: -32_600,
-          message: "Invalid request"
-        },
-        method_not_found: {
-          code: -32_601,
-          message: "Method not found"
-        },
-        invalid_params: {
-          code: -32_602,
-          message: "Invalid params"
-        },
-        internal_error: {
-          code: -32_603,
-          message: "Internal error"
-        },
-        server_error: {
-          code: -32_000,
-          message: "Server error"
-        }
-      }.freeze
-
-      # @return [Integer] The error code.
-      # @return [Object] The error data.
-      attr_reader :code, :data
-
-      # Retrieve error details by symbol.
-      #
-      # @param symbol [Symbol] The error symbol.
-      # @raise [ArgumentError] if the error code is unknown.
-      # @return [Hash] The error details.
-      def self.[](symbol)
-        ERROR_CODES[symbol] or raise ArgumentError, "Unknown error code: #{symbol}"
-      end
-
-      # Build an error hash, allowing custom message or data to override defaults.
-      #
-      # @param symbol [Symbol] The error symbol.
-      # @param message [String, nil] Optional custom message.
-      # @param data [Object, nil] Optional custom data.
-      # @return [Hash] The error hash.
-      def self.build(symbol, message: nil, data: nil)
-        error = self[symbol].dup
-        error[:message] = message if message
-        error[:data] = data if data
-        error
-      end
-
-      # Initialize the error using a symbol key, with optional custom message and data.
-      #
-      # @param symbol [Symbol] The error symbol.
-      # @param message [String, nil] Optional custom message.
-      # @param data [Object, nil] Optional custom data.
-      def initialize(symbol, message: nil, data: nil)
-        error_details = self.class.build(symbol, message: message, data: data)
-        @code = error_details[:code]
-        @data = error_details[:data]
-        super(error_details[:message])
-      end
-
-      # Returns a hash formatted for a JSON-RPC error response.
-      #
-      # @return [Hash] The error hash.
-      def to_h
-        hash = { code: code, message: message }
-        hash[:data] = data if data
-        hash
-      end
-
-      # Converts the error hash to a JSON string.
-      #
-      # @param _args [Array] Arguments passed to MultiJson.dump.
-      # @return [String] The JSON string.
-      def to_json(*_args)
-        MultiJson.dump(to_h, *args)
-      end
-    end
-  end
-end

data/lib/action_mcp/json_rpc/notification.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ActionMCP
-  module JsonRpc
-    # Represents a JSON-RPC notification.
-    Notification = Data.define(:method, :params) do
-      # Initializes a new Notification.
-      #
-      # @param method [String] The method name.
-      # @param params [Hash, nil] The parameters (optional).
-      def initialize(method:, params: nil)
-        super
-      end
-
-      # Returns a hash representation of the notification.
-      #
-      # @return [Hash] The hash representation.
-      def to_h
-        {
-          jsonrpc: "2.0",
-          method: method,
-          params: params
-        }.compact
-      end
-    end
-  end
-end

data/lib/action_mcp/json_rpc/request.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module ActionMCP
-  module JsonRpc
-    # Represents a JSON-RPC request.
-    Request = Data.define(:id, :method, :params) do
-      # Initializes a new Request.
-      #
-      # @param id [String, Numeric] The request identifier.
-      # @param method [String] The method name.
-      # @param params [Hash, nil] The parameters (optional).
-      # @raise [JsonRpcError] if the ID is invalid.
-      def initialize(id:, method:, params: nil)
-        validate_id(id)
-        super
-      end
-
-      # Returns a hash representation of the request.
-      #
-      # @return [Hash] The hash representation.
-      def to_h
-        hash = {
-          jsonrpc: "2.0",
-          id: id,
-          method: method
-        }
-        hash[:params] = params if params
-        hash
-      end
-
-      private
-
-      # Validates the ID.
-      #
-      # @param id [Object] The ID to validate.
-      # @raise [JsonRpcError] if the ID is invalid.
-      def validate_id(id)
-        unless id.is_a?(String) || id.is_a?(Numeric)
-          raise JsonRpcError.new(:invalid_params,
-                                 message: "ID must be a string or number")
-        end
-        raise JsonRpcError.new(:invalid_params, message: "ID must not be null") if id.nil?
-      end
-    end
-  end
-end

data/lib/action_mcp/json_rpc/response.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module ActionMCP
-  module JsonRpc
-    # Represents a JSON-RPC response.
-    Response = Data.define(:id, :result, :error) do
-      # Initializes a new Response.
-      #
-      # @param id [String, Numeric] The request identifier.
-      # @param result [Object, nil] The result data (optional).
-      # @param error [Object, nil] The error data (optional).
-      # @raise [ArgumentError] if neither result nor error is provided, or if both are provided.
-      def initialize(id:, result: nil, error: nil)
-        validate_presence_of_result_or_error!(result, error)
-        validate_absence_of_both_result_and_error!(result, error)
-        result, error = transform_value_to_hash!(result, error)
-
-        super(id: id, result: result, error: error)
-      end
-
-      # Returns a hash representation of the response.
-      #
-      # @return [Hash] The hash representation.
-      def to_h
-        {
-          jsonrpc: "2.0",
-          id: id,
-          result: result,
-          error: error
-        }.compact
-      end
-
-      def is_error?
-        error.present?
-      end
-
-      private
-
-      # Validates that either result or error is present.
-      #
-      # @param result [Object, nil] The result data.
-      # @param error [Object, nil] The error data.
-      # @raise [ArgumentError] if neither result nor error is provided.
-      def validate_presence_of_result_or_error!(result, error)
-        raise ArgumentError, "Either result or error must be provided." if result.nil? && error.nil?
-      end
-
-      # Validates that both result and error are not present simultaneously.
-      #
-      # @param result [Object, nil] The result data.
-      # @param error [Object, nil] The error data.
-      # @raise [ArgumentError] if both result and error are provided.
-      def validate_absence_of_both_result_and_error!(result, error)
-        raise ArgumentError, "Both result and error cannot be provided simultaneously." if result && error
-      end
-
-      def transform_value_to_hash!(result, error)
-        result = if result.is_a?(String)
-                   begin
-                     MultiJson.load(result)
-                   rescue StandardError
-                     result
-                   end
-        else
-                   result
-        end
-        error = if error.is_a?(String)
-                  begin
-                    MultiJson.load(error)
-                  rescue StandardError
-                    error
-                  end
-        else
-                  error
-        end
-        [ result, error ]
-      end
-    end
-  end
-end