actionmcp 0.14.0 → 0.17.0

data/app/models/action_mcp/session/message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # == Schema Information
 #
 # Table name: action_mcp_session_messages
@@ -24,110 +26,113 @@
 #  fk_action_mcp_session_messages_session_id  (session_id => action_mcp_sessions.id) ON DELETE => cascade ON UPDATE => cascade
 #
 module ActionMCP
-  ##
-  # Represents a message exchanged during an MCP session.
-  # Its role is to store the content and metadata of each message,
-  # including the direction (client or server), message type (request, response, notification),
-  # and any associated JSON-RPC ID.
-  class Session::Message < ApplicationRecord
-    belongs_to :session,
-               class_name: "ActionMCP::Session",
-               inverse_of: :messages,
-               counter_cache: true
-
-    delegate :adapter,
-             :role,
-             :session_key,
-             to: :session
-
-    # Virtual attribute for data
-    attr_reader :data
-
-    after_create_commit :broadcast_message, if: :outgoing_message?
-    # Set is_ping on responses if the original request was a ping
-    after_create :handle_ping_response, if: -> { %w[response error].include?(message_type) }
-
-    # Scope to exclude both "ping" requests and their responses
-    scope :without_pings, -> { where(is_ping: false) }
-
-    # @param payload [String, Hash]
-    def data=(payload)
-      @data = payload
-
-      # Store original version and attempt to determine type
-      if payload.is_a?(String)
-        self.message_text = payload
-        begin
-          parsed_json = MultiJson.load(payload)
-          self.message_json = parsed_json
-          process_json_content(parsed_json)
-        rescue MultiJson::ParseError
-          self.message_type = "text"
+  class Session
+    #
+    # Represents a message exchanged during an MCP session.
+    # Its role is to store the content and metadata of each message,
+    # including the direction (client or server), message type (request, response, notification),
+    # and any associated JSON-RPC ID.
+    class Message < ApplicationRecord
+      belongs_to :session,
+                 class_name: "ActionMCP::Session",
+                 inverse_of: :messages,
+                 counter_cache: true
+
+      delegate :adapter,
+               :role,
+               :session_key,
+               to: :session
+
+      # Virtual attribute for data
+      attr_reader :data
+
+      after_create_commit :broadcast_message, if: :outgoing_message?
+      # Set is_ping on responses if the original request was a ping
+      after_create :handle_ping_response, if: -> { %w[response error].include?(message_type) }
+
+      # Scope to exclude both "ping" requests and their responses
+      scope :without_pings, -> { where(is_ping: false) }
+
+      # @param payload [String, Hash]
+      def data=(payload)
+        @data = payload
+
+        # Store original version and attempt to determine type
+        if payload.is_a?(String)
+          self.message_text = payload
+          begin
+            parsed_json = MultiJson.load(payload)
+            self.message_json = parsed_json
+            process_json_content(parsed_json)
+          rescue MultiJson::ParseError
+            self.message_type = "text"
+          end
+        else
+          self.message_json = payload
+          self.message_text = MultiJson.dump(payload)
+          process_json_content(payload)
         end
-      else
-        self.message_json = payload
-        self.message_text = MultiJson.dump(payload)
-        process_json_content(payload)
       end
-    end
 
-    def data
-      message_json.presence || message_text
-    end
+      def data
+        message_json.presence || message_text
+      end
 
-    # Helper methods
-    def request?
-      message_type == "request"
-    end
+      # Helper methods
+      def request?
+        message_type == "request"
+      end
 
-    def notification?
-      message_type == "notification"
-    end
+      def notification?
+        message_type == "notification"
+      end
 
-    def response?
-      message_type == "response"
-    end
+      def response?
+        message_type == "response"
+      end
 
-    private
+      private
 
-    def outgoing_message?
-      direction != role
-    end
+      def outgoing_message?
+        direction != role
+      end
 
-    def broadcast_message
-      adapter.broadcast(session_key, data.to_json)
-    end
+      def broadcast_message
+        adapter.broadcast(session_key, data.to_json)
+      end
 
-    def process_json_content(content)
-      if content.is_a?(Hash) && content["jsonrpc"] == "2.0"
-        if content.key?("id") && content.key?("method")
-          self.message_type = "request"
-          self.jsonrpc_id = content["id"].to_s
-          # Set is_ping to true if the method is "ping"
-          self.is_ping = true if content["method"] == "ping"
-        elsif content.key?("method") && !content.key?("id")
-          self.message_type = "notification"
-        elsif content.key?("id") && content.key?("result")
-          self.message_type = "response"
-          self.jsonrpc_id = content["id"].to_s
-        elsif content.key?("id") && content.key?("error")
-          self.message_type = "error"
-          self.jsonrpc_id = content["id"].to_s
+      def process_json_content(content)
+        if content.is_a?(Hash) && content["jsonrpc"] == "2.0"
+          if content.key?("id") && content.key?("method")
+            self.message_type = "request"
+            self.jsonrpc_id = content["id"].to_s
+            # Set is_ping to true if the method is "ping"
+            self.is_ping = true if content["method"] == "ping"
+          elsif content.key?("method") && !content.key?("id")
+            self.message_type = "notification"
+          elsif content.key?("id") && content.key?("result")
+            self.message_type = "response"
+            self.jsonrpc_id = content["id"].to_s
+          elsif content.key?("id") && content.key?("error")
+            self.message_type = "error"
+            self.jsonrpc_id = content["id"].to_s
+          else
+            self.message_type = "invalid_jsonrpc"
+          end
         else
-          self.message_type = "invalid_jsonrpc"
+          self.message_type = "non_jsonrpc_json"
         end
-      else
-        self.message_type = "non_jsonrpc_json"
       end
-    end
 
-    def handle_ping_response
-      return unless jsonrpc_id.present?
-      request_message = session.messages.find_by(
-        jsonrpc_id: jsonrpc_id,
-        message_type: "request"
-      )
-      if request_message&.is_ping
+      def handle_ping_response
+        return unless jsonrpc_id.present?
+
+        request_message = session.messages.find_by(
+          jsonrpc_id: jsonrpc_id,
+          message_type: "request"
+        )
+        return unless request_message&.is_ping
+
         self.is_ping = true
         request_message.update(request_acknowledged: true)
         save! if changed?

data/app/models/action_mcp/session/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # == Schema Information
 #
 # Table name: action_mcp_session_resources
@@ -23,11 +25,13 @@
 #  fk_rails_...  (session_id => action_mcp_sessions.id) ON DELETE => cascade
 #
 module ActionMCP
-  ##
-  # Represents a resource associated with an MCP session.
-  # Its role is to store information about a resource, such as its URI, MIME type, description,
-  # and any associated metadata. It also tracks whether the resource was created by a tool and the last time it was accessed.
-  class Session::Resource < ApplicationRecord
-    belongs_to :session
+  class Session
+    #
+    # Represents a resource associated with an MCP session.
+    # Its role is to store information about a resource, such as its URI, MIME type, description,
+    # and any associated metadata. It also tracks whether the resource was created by a tool and the last time it was accessed.
+    class Resource < ApplicationRecord
+      belongs_to :session
+    end
   end
 end

data/app/models/action_mcp/session/subscription.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # == Schema Information
 #
 # Table name: action_mcp_session_subscriptions
@@ -18,13 +20,15 @@
 #  fk_rails_...  (session_id => action_mcp_sessions.id) ON DELETE => cascade
 #
 module ActionMCP
-  #
-  # Represents a client's subscription to a resource for real-time updates.
-  # Its role is to store the URI of the resource being subscribed to and track the last time a notification was sent for the subscription.
-  # All Subscriptions are deleted when the session is closed.
-  class Session::Subscription < ApplicationRecord
+  class Session
+    #
+    # Represents a client's subscription to a resource for real-time updates.
+    # Its role is to store the URI of the resource being subscribed to and track the last time a notification was sent for the subscription.
+    # All Subscriptions are deleted when the session is closed.
+    class Subscription < ApplicationRecord
       belongs_to :session,
                  class_name: "ActionMCP::Session",
                  inverse_of: :subscriptions
+    end
   end
 end

data/app/models/action_mcp/session.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # == Schema Information
 #
 # Table name: action_mcp_sessions
@@ -30,15 +32,15 @@ module ActionMCP
              dependent: :delete_all,
              inverse_of: :session
     has_many :subscriptions,
-              class_name: "ActionMCP::Session::Subscription",
-              foreign_key: "session_id",
-              dependent: :delete_all,
-              inverse_of: :session
+             class_name: "ActionMCP::Session::Subscription",
+             foreign_key: "session_id",
+             dependent: :delete_all,
+             inverse_of: :session
     has_many :resources,
-              class_name: "ActionMCP::Session::Resource",
-              foreign_key: "session_id",
-              dependent: :delete_all,
-              inverse_of: :session
+             class_name: "ActionMCP::Session::Resource",
+             foreign_key: "session_id",
+             dependent: :delete_all,
+             inverse_of: :session
 
     scope :pre_initialize, -> { where(status: "pre_initialize") }
     scope :closed, -> { where(status: "closed") }
@@ -60,9 +62,7 @@ module ActionMCP
       if data.is_a?(JsonRpc::Request) || data.is_a?(JsonRpc::Response) || data.is_a?(JsonRpc::Notification)
         data = data.to_json
       end
-      if data.is_a?(Hash)
-        data = MultiJson.dump(data)
-      end
+      data = MultiJson.dump(data) if data.is_a?(Hash)
 
       messages.create!(data: data, direction: writer_role)
     end
@@ -101,9 +101,10 @@ module ActionMCP
 
     def initialize!
       # update the session initialized to true if client_capabilities are present
+      return unless client_capabilities.present?
+
       update!(initialized: true,
-              status: "initialized"
-      ) if client_capabilities.present?
+              status: "initialized")
     end
 
     def message_flow
@@ -122,6 +123,14 @@ module ActionMCP
       end
     end
 
+    def resource_subscribe(uri)
+      subscriptions.find_or_create_by(uri: uri)
+    end
+
+    def resource_unsubscribe(uri)
+      subscriptions.find_by(uri: uri)&.destroy
+    end
+
     private
 
     # if this session is from a server, the writer is the client

data/app/models/action_mcp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionMCP
   def self.table_name_prefix
     "action_mcp_"

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ActionMCP::Engine.routes.draw do
   get "/", to: "sse#events", as: :sse_out
   post "/", to: "messages#create", as: :sse_in

data/db/migrate/20250308122801_create_action_mcp_sessions.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 class CreateActionMCPSessions < ActiveRecord::Migration[8.0]
   def change
     create_table :action_mcp_sessions, id: :string do |t|
-      t.string :role, null: false, default: "server", comment: "The role of the session"
-      t.string :status, null: false, default: "pre_initialize"
-      t.datetime :ended_at, comment: "The time the session ended"
+      t.string :role, null: false, default: 'server', comment: 'The role of the session'
+      t.string :status, null: false, default: 'pre_initialize'
+      t.datetime :ended_at, comment: 'The time the session ended'
       t.string :protocol_version
-      t.jsonb :server_capabilities, comment: "The capabilities of the server"
-      t.jsonb :client_capabilities, comment: "The capabilities of the client"
-      t.jsonb :server_info, comment: "The information about the server"
-      t.jsonb :client_info, comment: "The information about the client"
+      t.jsonb :server_capabilities, comment: 'The capabilities of the server'
+      t.jsonb :client_capabilities, comment: 'The capabilities of the client'
+      t.jsonb :server_info, comment: 'The information about the server'
+      t.jsonb :client_info, comment: 'The information about the client'
       t.boolean :initialized, null: false, default: false
       t.integer :messages_count, null: false, default: 0
       t.timestamps
@@ -18,9 +20,9 @@ class CreateActionMCPSessions < ActiveRecord::Migration[8.0]
       t.references :session, null: false, foreign_key: { to_table: :action_mcp_sessions,
                                                          on_delete: :cascade,
                                                          on_update: :cascade,
-                                                         name: "fk_action_mcp_session_messages_session_id" }, type: :string
-      t.string :direction, null: false, comment: "The session direction", default: "client"
-      t.string :message_type, null: false, comment: "The type of the message"
+                                                         name: 'fk_action_mcp_session_messages_session_id' }, type: :string
+      t.string :direction, null: false, comment: 'The session direction', default: 'client'
+      t.string :message_type, null: false, comment: 'The type of the message'
       t.string :jsonrpc_id
       t.string :message_text
       t.jsonb :message_json

data/db/migrate/20250314230152_add_is_ping_to_session_message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddIsPingToSessionMessage < ActiveRecord::Migration[8.0]
   def change
     add_column :action_mcp_session_messages, :is_ping, :boolean, default: false, null: false

data/db/migrate/20250316005021_create_action_mcp_session_subscriptions.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 class CreateActionMCPSessionSubscriptions < ActiveRecord::Migration[8.0]
   def change
     create_table :action_mcp_session_subscriptions do |t|
       t.references :session,
                    null: false,
                    foreign_key: { to_table: :action_mcp_sessions, on_delete: :cascade },
-                    type: :string
+                   type: :string
       t.string :uri, null: false
       t.datetime :last_notification_at
 

data/db/migrate/20250316005649_create_action_mcp_session_resources.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateActionMCPSessionResources < ActiveRecord::Migration[8.0]
   def change
     create_table :action_mcp_session_resources do |t|
@@ -15,8 +17,8 @@ class CreateActionMCPSessionResources < ActiveRecord::Migration[8.0]
 
       t.timestamps
     end
-    change_column_comment :action_mcp_session_messages, :direction, "The message recipient"
-    change_column_comment :action_mcp_session_messages, :is_ping, "Whether the message is a ping"
+    change_column_comment :action_mcp_session_messages, :direction, 'The message recipient'
+    change_column_comment :action_mcp_session_messages, :is_ping, 'Whether the message is a ping'
     rename_column :action_mcp_session_messages, :ping_acknowledged, :request_acknowledged
     add_column :action_mcp_session_messages, :request_cancelled, :boolean, null: false, default: false
   end

data/exe/actionmcp_cli

@@ -11,27 +11,31 @@ require 'logger'
 
 # Default options
 options = {
-  logging_level: "INFO",
+  logging_level: 'INFO',
   auto_initialize: true
 }
 
 # Set up logger
-logger = Logger.new(STDOUT)
+logger = Logger.new($stdout)
 logger.formatter = proc do |severity, _, _, msg|
   "#{severity}: #{msg}\n"
 end
 
 # Parse command-line arguments
 parser = OptionParser.new do |opts|
-  opts.banner = "Usage: mcp_client ENDPOINT [options]"
-  opts.on("-l", "--log-level LEVEL", "Set log level (DEBUG, INFO, WARN, ERROR)") do |l|
+  opts.banner = 'Usage: mcp_client ENDPOINT [options]'
+  opts.on('-l', '--log-level LEVEL', 'Set log level (DEBUG, INFO, WARN, ERROR)') do |l|
     options[:logging_level] = l.upcase
-    logger.level = Logger.const_get(l.upcase) rescue Logger::INFO
+    logger.level = begin
+      Logger.const_get(l.upcase)
+    rescue StandardError
+      Logger::INFO
+    end
   end
-  opts.on("--no-auto-init", "Don't automatically initialize the connection") do
+  opts.on('--no-auto-init', "Don't automatically initialize the connection") do
     options[:auto_initialize] = false
   end
-  opts.on("-h", "--help", "Show this help message") do
+  opts.on('-h', '--help', 'Show this help message') do
     puts opts
     exit
   end
@@ -44,7 +48,7 @@ endpoint = ARGV.shift
 parser.parse!(ARGV)
 
 if endpoint.nil?
-  puts "Error: You must provide an MCP endpoint."
+  puts 'Error: You must provide an MCP endpoint.'
   puts parser
   exit 1
 end
@@ -60,13 +64,13 @@ def parse_command(input)
   command = parts.shift
 
   case command
-  when "call_tool"
+  when 'call_tool'
     tool_name = parts.shift
     return nil unless tool_name
 
     arguments = {}
     parts.each do |arg|
-      key, value = arg.split(":", 2)
+      key, value = arg.split(':', 2)
       next unless value
 
       # Try to convert the value to appropriate type
@@ -75,11 +79,11 @@ def parse_command(input)
                        value.to_i
       when /^\d+\.\d+$/
                        value.to_f
-      when "true"
+      when 'true'
                        true
-      when "false"
+      when 'false'
                        false
-      when "null"
+      when 'null'
                        nil
       else
                        value
@@ -90,41 +94,39 @@ def parse_command(input)
 
     ActionMCP::JsonRpc::Request.new(
       id: generate_request_id,
-      method: "tools/get",
+      method: 'tools/get',
       params: {
-        "name" => tool_name,
-        "arguments" => arguments
+        'name' => tool_name,
+        'arguments' => arguments
       }
     )
-  when "list_tools"
+  when 'list_tools'
     ActionMCP::JsonRpc::Request.new(
       id: generate_request_id,
-      method: "tools/list"
+      method: 'tools/list'
     )
-  when "list_prompts"
+  when 'list_prompts'
     ActionMCP::JsonRpc::Request.new(
       id: generate_request_id,
-      method: "prompts/list"
+      method: 'prompts/list'
     )
-  else
-    nil
   end
 end
 
 # Help message for shortcuts
 def print_help
-  puts "Available shortcuts:"
-  puts "  list_tools"
-  puts "    - Get a list of available tools"
-  puts "  call_tool TOOL_NAME PARAM1:VALUE1 PARAM2:VALUE2 ..."
-  puts "    - Sends a tools/get request with the specified tool and parameters"
-  puts "  list_prompts"
-  puts "    - Get a list of available prompts"
-  puts "  get_prompt PROMPT_NAME PARAM1:VALUE1 PARAM2:VALUE2 ..."
-  puts "    - Sends a prompts/get request with the specified prompt and arguments"
-  puts "  help - Show this help message"
-  puts "  exit - Quit the client"
-  puts "Otherwise, enter a raw JSON-RPC request to send directly"
+  puts 'Available shortcuts:'
+  puts '  list_tools'
+  puts '    - Get a list of available tools'
+  puts '  call_tool TOOL_NAME PARAM1:VALUE1 PARAM2:VALUE2 ...'
+  puts '    - Sends a tools/get request with the specified tool and parameters'
+  puts '  list_prompts'
+  puts '    - Get a list of available prompts'
+  puts '  get_prompt PROMPT_NAME PARAM1:VALUE1 PARAM2:VALUE2 ...'
+  puts '    - Sends a prompts/get request with the specified prompt and arguments'
+  puts '  help - Show this help message'
+  puts '  exit - Quit the client'
+  puts 'Otherwise, enter a raw JSON-RPC request to send directly'
 end
 
 # Initialize and start the client
@@ -132,52 +134,52 @@ client = ActionMCP.create_client(endpoint, logger: logger)
 
 # Start the transport
 unless client.connect
-  error_msg = client.connection_error || "Unknown connection error"
+  error_msg = client.connection_error || 'Unknown connection error'
   puts "\nERROR: Failed to connect to MCP server at #{endpoint}"
   puts "Reason: #{error_msg}"
   puts "\nPlease check that:"
-  puts "  1. The server is running"
-  puts "  2. The endpoint URL/address is correct"
-  puts "  3. Any required firewall ports are open"
+  puts '  1. The server is running'
+  puts '  2. The endpoint URL/address is correct'
+  puts '  3. Any required firewall ports are open'
 
-  if endpoint =~ /\Ahttps?:\/\//
-    puts "  4. The URL includes the correct protocol, host, and port"
-    puts "     For example: http://localhost:3000/action_mcp"
+  if endpoint =~ %r{\Ahttps?://}
+    puts '  4. The URL includes the correct protocol, host, and port'
+    puts '     For example: http://localhost:3000/action_mcp'
   end
 
   exit 1
 end
 
-Signal.trap("INT") do
+Signal.trap('INT') do
   puts "\nReceived Ctrl+C. Disconnecting..."
   client.disconnect
-  puts "MCP Client stopped."
+  puts 'MCP Client stopped.'
   exit 0
 end
 
 # Main REPL loop
 loop do
-  print "mcp> "
+  print 'mcp> '
   input = gets&.chomp
   break unless input # Handle EOF
   next if input.empty?
 
   case input.downcase
-  when "exit"
+  when 'exit'
     break
-  when "help"
+  when 'help'
     print_help
     next
   else
     begin
       # Check if input is a command shortcut
-      if input.start_with?("call_tool")
+      if input.start_with?('call_tool')
         request = parse_command(input)
         logger.debug("Parsed shortcut to: #{request.to_h}") if request
-      elsif input.start_with?("connect") || input.start_with?("initialize")
+      elsif input.start_with?('connect') || input.start_with?('initialize')
         request = parse_command(input)
         logger.debug("Initializing connection with: #{request.to_h}") if request
-      elsif input.start_with?("list_tools") || input.start_with?("list_prompts")
+      elsif input.start_with?('list_tools') || input.start_with?('list_prompts')
         request = parse_command(input)
         logger.debug("Requesting tool list: #{request.to_h}") if request
       else
@@ -185,11 +187,11 @@ loop do
         begin
           json = MultiJson.load(input)
           # Validate that the parsed JSON has the required fields
-          if json["method"]
+          if json['method']
             request = ActionMCP::JsonRpc::Request.new(
-              id: json["id"] || generate_request_id,
-              method: json["method"],
-              params: json["params"]
+              id: json['id'] || generate_request_id,
+              method: json['method'],
+              params: json['params']
             )
           else
             puts "Invalid JSON-RPC request: missing 'method' field"
@@ -216,6 +218,6 @@ loop do
   end
 end
 
-puts "Disconnecting..."
+puts 'Disconnecting...'
 client.disconnect
-puts "MCP Client stopped."
+puts 'MCP Client stopped.'