actionmcp 0.2.0 → 0.2.4

data/lib/action_mcp/transport.rb

@@ -1,238 +1,4 @@
-# frozen_string_literal: true
-
 module ActionMCP
-  class Transport
-    HEARTBEAT_INTERVAL = 15 # seconds
-    attr_reader :initialized
-
-    # Initializes a new Transport.
-    #
-    # @param output_io [IO] An IO-like object where events will be written.
-    def initialize(output_io)
-      # output_io can be any IO-like object where we write events.
-      @output = output_io
-      @output.sync = true
-      @initialized = false
-      @client_capabilities = {}
-      @client_info = {}
-      @protocol_version = ""
-    end
-
-    # Sends the capabilities JSON-RPC notification.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    def send_capabilities(request_id, params = {})
-      @protocol_version = params["protocolVersion"]
-      @client_info = params["clientInfo"]
-      @client_capabilities = params["capabilities"]
-      Rails.logger.info("Client capabilities stored: #{@client_capabilities}")
-      capabilities = {}
-
-      # Only include each capability if the corresponding registry is non-empty.
-      capabilities[:tools] = { listChanged: ActionMCP.configuration.list_changed } if ToolsRegistry.available_tools.any?
-      if PromptsRegistry.available_prompts.any?
-        capabilities[:prompts] =
-          { listChanged: ActionMCP.configuration.list_changed }
-      end
-      capabilities[:resources] = { subscribe: ActionMCP.configuration.list_changed } if ResourcesBank.all_resources.any?
-      capabilities[:logging] = {} if ActionMCP.configuration.logging_enabled
-
-      payload = {
-        protocolVersion: "2024-11-05",
-        capabilities: capabilities,
-        serverInfo: {
-          name: ActionMCP.configuration.name,
-          version: ActionMCP.configuration.version
-        }
-      }
-      send_jsonrpc_response(request_id, result: payload)
-    end
-
-    def initialized!
-      @initialized = true
-      Rails.logger.info("Transport initialized.")
-    end
-
-    # Sends the resources list JSON-RPC response.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    def send_resources_list(request_id)
-      resources = ResourcesBank.all_resources # fetch all resources
-      result_data = { "resources" => resources }
-      send_jsonrpc_response(request_id, result: result_data)
-      Rails.logger.info("resources/list: Returned #{resources.size} resources.")
-    rescue StandardError => e
-      Rails.logger.error("resources/list failed: #{e.message}")
-      error_obj = JsonRpc::JsonRpcError.new(
-        :internal_error,
-        message: "Failed to list resources: #{e.message}"
-      ).as_json
-      send_jsonrpc_response(request_id, error: error_obj)
-    end
-
-    # Sends the resource templates list JSON-RPC response.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    def send_resource_templates_list(request_id)
-      templates = ResourcesBank.all_templates # get all resource templates
-      result_data = { "resourceTemplates" => templates }
-      send_jsonrpc_response(request_id, result: result_data)
-      Rails.logger.info("resources/templates/list: Returned #{templates.size} resource templates.")
-    rescue StandardError => e
-      Rails.logger.error("resources/templates/list failed: #{e.message}")
-      error_obj = JsonRpc::JsonRpcError.new(
-        :internal_error,
-        message: "Failed to list resource templates: #{e.message}"
-      ).as_json
-      send_jsonrpc_response(request_id, error: error_obj)
-    end
-
-    # Sends the resource read JSON-RPC response.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    # @param params [Hash] The parameters including the 'uri' for the resource.
-    def send_resource_read(request_id, params)
-      uri = params&.fetch("uri", nil)
-      if uri.nil? || uri.empty?
-        Rails.logger.error("resources/read: 'uri' parameter is missing")
-        error_obj = JsonRpc::JsonRpcError.new(
-          :invalid_params,
-          message: "Missing 'uri' parameter for resources/read"
-        ).as_json
-        return send_jsonrpc_response(request_id, error: error_obj)
-      end
-
-      begin
-        content = ResourcesBank.read(uri) # Expecting an instance of an ActionMCP::Content subclass
-        if content.nil?
-          Rails.logger.error("resources/read: Resource not found for URI #{uri}")
-          error_obj = JsonRpc::JsonRpcError.new(
-            :invalid_params,
-            message: "Resource not found: #{uri}"
-          ).as_json
-          return send_jsonrpc_response(request_id, error: error_obj)
-        end
-
-        # Use the content object's `to_h` to build the JSON-RPC result.
-        result_data = { "contents" => [ content.to_h ] }
-        send_jsonrpc_response(request_id, result: result_data)
-
-        log_msg = "resources/read: Successfully read content of #{uri}"
-        log_msg += " (#{content.text.size} bytes)" if content.respond_to?(:text) && content.text
-        Rails.logger.info(log_msg)
-      rescue StandardError => e
-        Rails.logger.error("resources/read: Error reading #{uri} - #{e.message}")
-        error_obj = JsonRpc::JsonRpcError.new(
-          :internal_error,
-          message: "Failed to read resource: #{e.message}"
-        ).as_json
-        send_jsonrpc_response(request_id, error: error_obj)
-      end
-    end
-
-    # Sends the tools list JSON-RPC notification.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    def send_tools_list(request_id)
-      tools = format_registry_items(ToolsRegistry.available_tools)
-      send_jsonrpc_response(request_id, result: { tools: tools })
-    end
-
-    # Sends a call to a tool.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    # @param tool_name [String] The name of the tool.
-    # @param arguments [Hash] The arguments for the tool.
-    # @param _meta [Hash] Additional metadata.
-    def send_tools_call(request_id, tool_name, arguments, _meta = {})
-      result = ToolsRegistry.tool_call(tool_name, arguments, _meta)
-      send_jsonrpc_response(request_id, result:)
-    rescue RegistryBase::NotFound
-      send_jsonrpc_response(request_id, error: JsonRpc::JsonRpcError.new(:method_not_found,
-                                                                         message: "Tool not found: #{tool_name}").as_json)
-    end
-
-    # Sends the prompts list JSON-RPC notification.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    def send_prompts_list(request_id)
-      prompts = format_registry_items(PromptsRegistry.available_prompts)
-      send_jsonrpc_response(request_id, result: { prompts: prompts })
-    end
-
-    def send_prompts_get(request_id, prompt_name, params)
-      send_jsonrpc_response(request_id, result: PromptsRegistry.prompt_call(prompt_name.to_s, params))
-    rescue RegistryBase::NotFound
-      send_jsonrpc_response(request_id, error: JsonRpc::JsonRpcError.new(:method_not_found,
-                                                                         message: "Prompt not found: #{prompt_name}").as_json)
-    end
-
-    # Sends the roots list JSON-RPC request.
-    # TODO: test it
-    def send_roots_list
-      send_jsonrpc_request("roots/list")
-    end
-
-    # Sends a JSON-RPC pong response.
-    # We don't actually to send any data back because the spec are not fun anymore.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    def send_pong(request_id)
-      send_jsonrpc_response(request_id, result: {})
-    end
-
-    def send_ping
-      send_jsonrpc_request("ping")
-    end
-
-    # Sends a JSON-RPC request.
-    # @param method [String] The JSON-RPC method.
-    # @param params [Hash] The parameters for the method.
-    # @param id [String] The request identifier.
-    def send_jsonrpc_request(method, params: nil, id: SecureRandom.uuid_v7)
-      request = JsonRpc::Request.new(id: id, method: method, params: params)
-      write_message(request.to_json)
-    end
-
-    # Sends a JSON-RPC response.
-    #
-    # @param request_id [String, Integer] The request identifier.
-    # @param result [Object] The result data.
-    # @param error [Object, nil] The error data, if any.
-    def send_jsonrpc_response(request_id, result: nil, error: nil)
-      response = JsonRpc::Response.new(id: request_id, result: result, error: error)
-      write_message(response.to_json)
-    end
-
-    # Sends a generic JSON-RPC notification (no response expected).
-    #
-    # @param method [String] The JSON-RPC method.
-    # @param params [Hash] The parameters for the method.
-    def send_jsonrpc_notification(method, params = nil)
-      notification = JsonRpc::Notification.new(method: method, params: params)
-      write_message(notification.to_json)
-    end
-
-    private
-
-    # Formats registry items to a hash representation.
-    #
-    # @param registry [Hash] The registry containing tool or prompt definitions.
-    # @return [Array<Hash>] The formatted registry items.
-    def format_registry_items(registry)
-      registry.map { |item| item.klass.to_h }
-    end
-
-    # Writes a message to the output IO.
-    #
-    # @param data [String] The data to write.
-    def write_message(data)
-      Timeout.timeout(5) do # 5 second timeout
-        @output.write("#{data}\n")
-      end
-    rescue Timeout::Error
-      Rails.logger.error("Write operation timed out")
-      # Handle timeout appropriately
-    end
+  module Transport
   end
 end

data/lib/action_mcp/transport_handler.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ActionMCP
+  class TransportHandler
+    include Logging
+
+    include Transport::Capabilities
+    include Transport::Tools
+    include Transport::Prompts
+    include Transport::Messaging
+
+    HEARTBEAT_INTERVAL = 15 # seconds
+    attr_reader :initialized
+
+    def initialize(output_io)
+      @output = output_io
+      @output.sync = true if @output.respond_to?(:sync=)
+      @initialized = false
+      @client_capabilities = {}
+      @client_info = {}
+      @protocol_version = ""
+    end
+
+    def send_ping
+      send_jsonrpc_request("ping")
+    end
+
+    def send_pong(request_id)
+      send_jsonrpc_response(request_id, result: {})
+    end
+
+    def initialized?
+      @initialized
+    end
+
+    def initialized!
+      @initialized = true
+    end
+
+    private
+
+    def write_message(data)
+      Timeout.timeout(5) do
+        @output.write("#{data}\n")
+      end
+    rescue Timeout::Error
+      # ActionMCP.logger.error("Write operation timed out")
+    end
+
+    def format_registry_items(registry)
+      registry.map { |item| item.klass.to_h }
+    end
+  end
+end

data/lib/action_mcp/version.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "gem_version"
-
 module ActionMCP
-  VERSION = "0.2.0"
-  # Returns the currently loaded version of Active MCP as a +Gem::Version+.
-  def self.version
-    gem_version
+  VERSION = "0.2.4"
+
+  class << self
+    alias version gem_version
   end
 end

data/lib/action_mcp.rb

@@ -2,58 +2,61 @@
 
 require "rails"
 require "active_support"
-require "active_model"
-require "action_mcp/version"
+require "active_support/rails"
 require "multi_json"
-require "action_mcp/railtie" if defined?(Rails)
-require_relative "action_mcp/integer_array"
-require_relative "action_mcp/string_array"
+require "concurrent"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_cable/engine"
+require "action_mcp/engine"
+require "zeitwerk"
 
-ActiveSupport::Inflector.inflections(:en) do |inflect|
-  inflect.acronym "MCP"
-end
-module ActionMCP
-  extend ActiveSupport::Autoload
-
-  autoload :RegistryBase
-  autoload :Resource
-  autoload :ToolsRegistry
-  autoload :PromptsRegistry
-  autoload :ResourcesBank
-  autoload :Tool
-  autoload :Prompt
-  autoload :JsonRpc
-  autoload :Transport
-  autoload :Content
-  autoload :Renderable
-
-  eager_autoload do
-    autoload :Configuration
-  end
+lib = File.dirname(__FILE__)
 
-  # Accessor for the configuration instance.
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore(
+    "#{lib}/generators",
+    "#{lib}/action_mcp/version.rb",
+    "#{lib}/action_mcp/gem_version.rb",
+    "#{lib}/actionmcp.rb"
+  )
 
-  def self.configure
-    yield(configuration)
-  end
+  loader.inflector.inflect("action_mcp" => "ActionMCP")
+  loader.inflector.inflect("sse_client" => "SSEClient")
+  loader.inflector.inflect("sse_server" => "SSEServer")
+end.setup
+
+module ActionMCP
+  require_relative "action_mcp/version"
+  require_relative "action_mcp/configuration"
+  PROTOCOL_VERSION =  "2024-11-05"
 
   module_function
 
+  # Returns the tools registry.
+  #
+  # @return [Hash] the tools registry
   def tools
     ToolsRegistry.tools
   end
 
+  # Returns the prompts registry.
+  #
+  # @return [Hash] the prompts registry
   def prompts
     PromptsRegistry.prompts
   end
 
+  # Returns the available tools.
+  #
+  # @return [ActionMCP::RegistryBase::RegistryScope] the available tools
   def available_tools
     ToolsRegistry.available_tools
   end
 
+  # Returns the available prompts.
+  #
+  # @return [ActionMCP::RegistryBase::RegistryScope] the available prompts
   def available_prompts
     PromptsRegistry.available_prompts
   end

data/lib/generators/action_mcp/prompt/templates/prompt.rb.erb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+# Template for generating new prompts.
 class <%= class_name %> < ApplicationPrompt
+  # Set the prompt name.
   prompt_name "<%= prompt_name %>"
 
   # Provide a user-facing description for your prompt.
@@ -13,7 +15,7 @@ class <%= class_name %> < ApplicationPrompt
   # Add validations (note: "Ruby" is not allowed per the validation)
   validates :language, inclusion: { in: %w[Ruby C Cobol FORTRAN] }
 
+  # Implement your prompt's behavior here
   def call
-    # Implement your prompt's behavior here
   end
 end

data/lib/generators/action_mcp/tool/templates/tool.rb.erb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
+# Template for generating new tools.
 class <%= class_name %> < ApplicationTool
+  # Set the tool name.
   tool_name "<%= tool_name %>"
   description "Calculate the sum of two numbers"
 
+  # Define input properties.
   property :a, type: "number", description: "First number", required: true
   property :b, type: "number", description: "Second number", required: true
 
+  # Implement the tool's logic here.
   def call
-    a + b
+    render_text(a + b)
   end
 end

data/lib/tasks/action_mcp_tasks.rake

@@ -1,6 +1,29 @@
-# frozen_string_literal: true
+namespace :action_mcp do
+  desc "List all tools with their names and descriptions"
+  task list_tools: :environment do
+    # Ensure Rails eager loads all classes
+    Rails.application.eager_load!
 
-# desc "Explaining what the task does"
-# task :action_mcp do
-#   # Task goes here
-# end
+    puts "\e[34mACTION MCP TOOLS\e[0m"  # Blue
+    puts "\e[34m---------------\e[0m"   # Blue
+    ActionMCP::Tool.descendants.each do |tool|
+      puts "\e[34m#{tool.capability_name}:\e[0m #{tool.description}"  # Blue name
+    end
+  end
+
+  desc "List all prompts with their names and descriptions"
+  task list_prompts: :environment do
+    # Ensure Rails eager loads all classes
+    Rails.application.eager_load!
+
+    puts "\e[32mACTION MCP PROMPTS\e[0m"  # Red
+    puts "\e[32m-----------------\e[0m"   # Red
+    ActionMCP::Prompt.descendants.each do |prompt|
+      puts "\e[32m#{prompt.capability_name}:\e[0m #{prompt.description}"  # Red name
+    end
+  end
+
+  desc "List all tools and prompts with their names and descriptions"
+  task list: [ :list_tools, :list_prompts ] do
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: actionmcp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Abdelkader Boudih
 bindir: exe
 cert_chain: []
-date: 2025-02-15 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,7 +24,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 8.0.1
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+- !ruby/object:Gem::Dependency
+  name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,20 +65,53 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 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:
 - terminale@gmail.com
 executables:
-- action_mcp_stdio
+- actionmcp_cli
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- exe/action_mcp_stdio
+- app/controllers/action_mcp/application_controller.rb
+- app/controllers/action_mcp/messages_controller.rb
+- app/controllers/action_mcp/sse_controller.rb
+- config/routes.rb
+- exe/actionmcp_cli
 - lib/action_mcp.rb
+- lib/action_mcp/capability.rb
 - lib/action_mcp/client.rb
 - lib/action_mcp/configuration.rb
 - lib/action_mcp/content.rb
@@ -72,6 +119,7 @@ files:
 - lib/action_mcp/content/image.rb
 - lib/action_mcp/content/resource.rb
 - lib/action_mcp/content/text.rb
+- lib/action_mcp/engine.rb
 - lib/action_mcp/gem_version.rb
 - lib/action_mcp/integer_array.rb
 - lib/action_mcp/json_rpc.rb
@@ -79,18 +127,26 @@ files:
 - 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.rb
+- lib/action_mcp/logging.rb
 - lib/action_mcp/prompt.rb
 - lib/action_mcp/prompts_registry.rb
-- lib/action_mcp/railtie.rb
 - lib/action_mcp/registry_base.rb
 - lib/action_mcp/renderable.rb
 - lib/action_mcp/resource.rb
-- lib/action_mcp/resources_bank.rb
 - lib/action_mcp/server.rb
 - lib/action_mcp/string_array.rb
 - lib/action_mcp/tool.rb
 - lib/action_mcp/tools_registry.rb
 - lib/action_mcp/transport.rb
+- lib/action_mcp/transport/capabilities.rb
+- lib/action_mcp/transport/messaging.rb
+- lib/action_mcp/transport/prompts.rb
+- lib/action_mcp/transport/sse_client.rb
+- lib/action_mcp/transport/stdio_client.rb
+- lib/action_mcp/transport/tools.rb
+- lib/action_mcp/transport/transport_base.rb
+- lib/action_mcp/transport_handler.rb
 - lib/action_mcp/version.rb
 - lib/actionmcp.rb
 - lib/generators/action_mcp/install/install_generator.rb
@@ -107,6 +163,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/seuros/action_mcp
   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'
 rdoc_options: []
 require_paths:
@@ -122,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Provides essential tooling for building Model Context Protocol (MCP) capable
   servers

data/lib/action_mcp/railtie.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "rails"
-require "active_model/railtie"
-
-module ActionMCP
-  class Railtie < Rails::Railtie # :nodoc:
-    # Provide a configuration namespace for ActionMCP
-    config.action_mcp = ActiveSupport::OrderedOptions.new
-
-    config.after_initialize do |app|
-      options = app.config.action_mcp.to_h.symbolize_keys
-
-      # Override the default configuration if specified in the Rails app.
-      ActionMCP.configuration.name = options[:name] if options.key?(:name)
-      ActionMCP.configuration.version = options[:version] if options.key?(:version)
-      ActionMCP.configuration.logging_enabled = options.fetch(:logging_enabled, true)
-    end
-
-    initializer "action_mcp.clear_registry" do |app|
-      app.config.to_prepare do
-        ActionMCP::ToolsRegistry.clear!
-        ActionMCP::PromptsRegistry.clear!
-      end
-    end
-  end
-end