actionmcp 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a6f6ad112f762c4721ee472efd560bc3d67ccba63e0c738ef8fa34389dd98d
-  data.tar.gz: 9d095dad87a5275cb42faa802a839da3d21c435ba4c6f6222579c2db5cb09523
+  metadata.gz: 529a0b8315fdd1d869ab3310d18c9a0ecb316eb3b1b5ab54f13ad93588e55152
+  data.tar.gz: 1dc90c03f28134264025649f4fa7b4a3ed97d98c7375c437ddcb0548461aa2cd
 SHA512:
-  metadata.gz: 39b63323aa753e1fd8acaa31654fae037fef84a41810d85c9a759d9b8a78b1e93de66e4a8cc170652bfefde726c73bbdb3f42c34d2c611ed589b6e16d8d66bbd
-  data.tar.gz: 471eb542dfb0516b4cccd50a9c50de1346da2b5b0365f50ecaa77aaf1a0670f1982c5ddda218a844bcc3446e2d26cc0e8cb64dc4a144d47eeee04d9c81692d10
+  metadata.gz: 2e7abf47b0ed09eff25c2d2097f4654ae8d4766810f458cad51ab217698a206cbb7375ecaf4b3bd23db70fa6fd31d4c34ac4db6f2ec723187f68deb8bca94e91
+  data.tar.gz: da41afe6699282401e85b9981c29f0c04906dce1b5574096c456d7508f9866ef6cb396c642c32b3f78e96f68d50c95e7d0077dccc6bd5e1dacf5816d8a1978c8

data/README.md

@@ -121,7 +121,7 @@ class AnalyzeCodePrompt < ApplicationPrompt
   
   def call
     # Implement your prompt logic here
-    render_text("Analyzing #{language} code: #{code}")
+    render(text: "Analyzing #{language} code: #{code}")
   end
 end
 ```
@@ -145,7 +145,7 @@ class CalculateSumTool < ApplicationTool
   property :b, type: "number", description: "Second number", required: true
   
   def call
-    render_text(a + b)
+    render(text: a + b)
   end
 end
 ```
@@ -189,7 +189,6 @@ end
 ```ruby
 # Instantiate the tool with initial values
 sum_tool = CalculateSumTool.new(a: 5, b: 10)
-
 # Optionally update attributes later:
 sum_tool.a = 15
 sum_tool.b = 20
@@ -232,6 +231,46 @@ These examples show that both prompts and tools follow a consistent pattern for
 - **API Stability:**
   The ActionMCP API is stable, though it is acceptable for improvements and changes to be introduced as we move forward. This approach ensures the gem stays modern and adaptable to evolving requirements.
 
+## Testing with the TestHelper
+
+ActionMCP provides a `TestHelper` module to simplify testing of tools and prompts. To use the `TestHelper`, include it in your test class:
+
+```ruby
+require "test_helper"
+require "action_mcp/test_helper"
+
+class ToolTest < ActiveSupport::TestCase
+  include ActionMCP::TestHelper
+
+  test "CalculateSumTool returns the correct sum" do
+    assert_tool_findable("calculate_sum")
+    result = execute_tool("calculate_sum", a: 5, b: 10)
+    assert_tool_output(result, "15.0")
+  end
+
+  test "AnalyzeCodePrompt returns the correct analysis" do
+    assert_prompt_findable("analyze_code")
+    result = execute_tool("analyze_code", language: "Ruby", code: "def hello; puts 'Hello, world!'; end")
+    assert_equal "Analyzing Ruby code: def hello; puts 'Hello, world!'; end", assert_prompt_output(result)
+  end
+end
+```
+
+The `TestHelper` module provides the following methods:
+
+*   `assert_tool_findable(tool_name)`: Asserts that a tool is findable in the `ToolsRegistry`.
+*   `assert_prompt_findable(prompt_name)`: Asserts that a prompt is findable in the `PromptsRegistry`.
+*   `execute_tool(tool_name, args = {})`: Executes a tool with the given name and arguments.
+*   `execute_prompt(prompt_name, args = {})`: Executes a prompt with the given name and arguments.
+*   `assert_tool_output(result, expected_output)`: Asserts that the output of a tool is equal to the expected output.
+*   `assert_prompt_output(result)`: Asserts that the output of a prompt is equal to the expected output.
+
+To use the `TestHelper`, you need to require it in your `test_helper.rb` file:
+
+```ruby
+require "action_mcp/test_helper"
+```
+
 ## Conclusion
 
-ActionMCP empowers developers to build MCP-compliant servers efficiently by handling the standardization and boilerplate associated with integrating with LLMs. With built-in generators, clear configuration options, robust usage examples, and important deployment considerations, it is designed to accelerate development and integration work while remaining flexible for future enhancements.
+ActionMCP empowers developers to build MCP-compliant servers efficiently by handling the standardization and boilerplate associated with integrating with LLMs. With built-in generators, clear configuration options, robust usage examples, important deployment considerations, and a helpful testing module, it is designed to accelerate development and integration work while remaining flexible for future enhancements.

data/app/models/action_mcp/session.rb

@@ -17,7 +17,8 @@ module ActionMCP
     validates :protocol_version, inclusion: { in: [ PROTOCOL_VERSION ] }, allow_nil: true
 
     def close!
-      adapter.unsubscribe(session_key, _)
+      dummy_callback = ->(*) { } # this callback seem broken
+      adapter.unsubscribe(session_key, dummy_callback)
       update!(status: "closed", ended_at: Time.zone.now)
     end
 
@@ -33,7 +34,6 @@ module ActionMCP
     end
 
     def read(data)
-      puts "\e[33m[#{role}] #{data}\e[0m"
       messages.create!(data: data, direction: role)
     end
 

data/lib/action_mcp/configuration.rb

@@ -40,11 +40,12 @@ module ActionMCP
     def capabilities
       capabilities = {}
       # Only include each capability if the corresponding registry is non-empty.
-      capabilities[:tools] = { listChanged: @list_changed } if ToolsRegistry.non_abstract.any?
-      capabilities[:prompts] = { listChanged: @list_changed } if PromptsRegistry.non_abstract.any?
+      capabilities[:tools] = { listChanged: false } if ToolsRegistry.non_abstract.any?
+      capabilities[:prompts] = { listChanged: false } if PromptsRegistry.non_abstract.any?
       capabilities[:logging] = {} if @logging_enabled
-      # capabilities[:resources] = { subscribe: @resources_subscribe,
-      #                              listChanged: @list_changed }.compact
+      # For now, we only have one type of resource, ResourceTemplate
+      # For Resources, we need to think about how to pass the list to the session.
+      capabilities[:resources] = {} if ResourceTemplatesRegistry.non_abstract.any?
       capabilities
     end
   end

data/lib/action_mcp/json_rpc_handler.rb

@@ -42,38 +42,40 @@ module ActionMCP
       return if request["error"]
       return if request["result"] == {} # Probably a pong
 
-      method = request["method"]
+      rpc_method = request["method"]
       id = request["id"]
       params = request["params"]
 
-      case method
+      case rpc_method
       when "initialize"
-        puts "\e[31mSending capabilities\e[0m"
         transport.send_capabilities(id, params)
       when "ping"
         transport.send_pong(id)
       when /^notifications\//
         puts "\e[31mProcessing notifications\e[0m"
-        process_notifications(method)
+        process_notifications(rpc_method, params)
       when /^prompts\//
-        process_prompts(method, id, params)
+        process_prompts(rpc_method, id, params)
       when /^resources\//
-        process_resources(method, id, params)
+        process_resources(rpc_method, id, params)
       when /^tools\//
-        process_tools(method, id, params)
+        process_tools(rpc_method, id, params)
       when "completion/complete"
         process_completion_complete(id, params)
       else
-        puts "\e[31mUnknown method: #{method} #{request}\e[0m"
+        puts "\e[31mUnknown method: #{rpc_method} #{request}\e[0m"
       end
     end
 
     # @param rpc_method [String]
-    def process_notifications(rpc_method)
+    def process_notifications(rpc_method, params)
       case rpc_method
       when "notifications/initialized"
         puts "\e[31mInitialized\e[0m"
         transport.initialize!
+      when "notifications/cancelled"
+        puts "\e[31m Request #{params["requestId"]} cancelled: #{params["reason"]}\e[0m"
+        # we don't need to do anything here
       else
         Rails.logger.warn("Unknown notifications method: #{rpc_method}")
       end

data/lib/action_mcp/renderable.rb

@@ -3,52 +3,23 @@
 module ActionMCP
   # Module for rendering content.
   module Renderable
-    # Renders text content.
-    #
-    # @param text [String] The text to render.
-    # @return [Content::Text] The rendered text content.
-    def render_text(text)
-      Content::Text.new(text)
-    end
-
-    # Renders audio content.
-    #
-    # @param data [String] The audio data.
-    # @param mime_type [String] The MIME type of the audio data.
-    # @return [Content::Audio] The rendered audio content.
-    def render_audio(data, mime_type)
-      Content::Audio.new(data, mime_type)
-    end
-
-    # Renders image content.
-    #
-    # @param data [String] The image data.
-    # @param mime_type [String] The MIME type of the image data.
-    # @return [Content::Image] The rendered image content.
-    def render_image(data, mime_type)
-      Content::Image.new(data, mime_type)
-    end
-
-    # Renders a resource.
-    #
-    # @param uri [String] The URI of the resource.
-    # @param mime_type [String] The MIME type of the resource.
-    # @param text [String, nil] The text associated with the resource.
-    # @param blob [String, nil] The blob associated with the resource.
-    # @return [Content::Resource] The rendered resource content.
-    def render_resource(uri, mime_type, text: nil, blob: nil)
-      Content::Resource.new(uri, mime_type, text: text, blob: blob)
-    end
-
-    # Renders an error.
-    #
-    # @param errors [Array<String>] The errors to render.
-    # @return [Hash] A hash containing the error information.
-    def render_error(errors)
-      {
-        isError: true,
-        content: errors.map { |error| render_text(error) }
-      }
+    def render(text: nil, audio: nil, image: nil, resource: nil, error: nil, mime_type: nil, uri: nil, blob: nil)
+      if text
+        Content::Text.new(text)
+      elsif audio && mime_type
+        Content::Audio.new(audio, mime_type)
+      elsif image && mime_type
+        Content::Image.new(image, mime_type)
+      elsif resource && uri && mime_type
+        Content::Resource.new(uri, mime_type, text: text, blob: blob)
+      elsif error
+        {
+          isError: true,
+          content: error.map { |e| render(text: e) }
+        }
+      else
+        raise ArgumentError, "No content to render"
+      end
     end
   end
 end

data/lib/action_mcp/resource_template.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ActionMCP
+  class ResourceTemplate
+    class_attribute :abstract, instance_accessor: false, default: false
+
+    attr_reader :description, :uri_template, :mime_type
+
+    def self.parameter(name, description:, required: false)
+      @parameters ||= {}
+      @parameters[name] = { description: description, required: required }
+    end
+
+    def self.parameters
+      @parameters || {}
+    end
+
+    def self.description(description = nil)
+      return @description unless description
+      @description = description
+    end
+
+    def self.to_h
+      name_value = defined?(@template_name) ? @template_name : name.demodulize.underscore.gsub(/_template$/, '')
+
+      {
+        uriTemplate: @uri_template,
+        name: name_value,
+        description: @description,
+        mimeType: @mime_type
+      }.compact
+    end
+
+    def self.uri_template(uri_template = nil)
+      return @uri_template unless uri_template
+      @uri_template = uri_template
+    end
+
+    def self.template_name(name = nil)
+      @template_name = name if name
+      @template_name
+    end
+
+    def self.mime_type(mime_type = nil)
+      return @mime_type unless mime_type
+      @mime_type = mime_type
+    end
+
+    def self.retrieve(_params)
+      raise NotImplementedError, "Subclasses must implement the retrieve method"
+    end
+
+    def self.abstract
+      @abstract_tool ||= false # Default to false, unique to each class
+    end
+
+    def self.abstract=(value)
+      @abstract_tool = value
+    end
+
+    def self.abstract!
+      self.abstract = true
+    end
+
+    def self.abstract?
+      abstract
+    end
+
+    def self.capability_name
+      name.demodulize.underscore.sub(/_template$/, "")
+    end
+  end
+end

data/lib/action_mcp/resource_templates_registry.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActionMCP
+  # Registry for managing resource templates.
+  class ResourceTemplatesRegistry < RegistryBase
+    class << self
+      # @!method resource_templates
+      #   Returns all registered resource templates.
+      #   @return [Hash] A hash of registered resource templates.
+      alias resource_templates items
+
+      # Retrieves a resource template by name.
+      #
+      # @param template_name [String] The name of the resource template to retrieve.
+      # @return [ActionMCP::ResourceTemplate] The resource template.
+      # @raise [RegistryBase::NotFound] if the resource template is not found.
+      def get_resource_template(template_name)
+        find(template_name)
+      end
+
+      def item_klass
+        ResourceTemplate
+      end
+    end
+  end
+end

data/lib/action_mcp/test_helper.rb

@@ -0,0 +1,38 @@
+require "active_support/testing/assertions"
+
+module ActionMCP
+  module TestHelper
+    include ActiveSupport::Testing::Assertions
+
+    def assert_tool_findable(tool_name)
+      assert ActionMCP::ToolsRegistry.tools.key?(tool_name), "Tool #{tool_name} not found in registry"
+    end
+
+    def assert_prompt_findable(prompt_name)
+      assert ActionMCP::PromptsRegistry.prompts.key?(prompt_name), "Prompt #{prompt_name} not found in registry"
+    end
+
+    def execute_tool(tool_name, args = {})
+      result = ActionMCP::ToolsRegistry.tool_call(tool_name, args)
+      assert_equal false, result[:isError], "Tool #{tool_name} returned an error: #{result[:content].map(&:text).join(', ')}" if result[:isError]
+      result
+    end
+
+    def execute_prompt(prompt_name, args = {})
+      result = ActionMCP::PromptsRegistry.prompt_call(prompt_name, args)
+       assert_equal false, result[:isError], "Prompt #{prompt_name} returned an error: #{result[:content].map(&:text).join(', ')}" if result[:isError]
+      result
+    end
+
+    def assert_tool_output(result, expected_output)
+       assert_equal expected_output, result[:content][0].text
+    end
+
+    def assert_prompt_output(result)
+      assert_equal "user", result[:messages][0][:role]
+      result[:messages][0][:content]
+    end
+
+    # Add more assertion methods as needed
+  end
+end

data/lib/action_mcp/transport/resources.rb

@@ -4,16 +4,26 @@ module ActionMCP
   module Transport
     module Resources
       def send_resources_list(request_id)
-        send_jsonrpc_response(request_id, result: {  resources: [] })
+        send_jsonrpc_response(request_id, result: { resources: [] })
       end
 
       def send_resource_templates_list(request_id)
-        send_jsonrpc_response(request_id, result: { templates: [] })
+        templates = ActionMCP::ResourceTemplatesRegistry.resource_templates.values.map do |template|
+          template.to_h
+        end
+        # TODO add pagination support
+        # TODO add autocomplete
+        log_resource_templates
+        send_jsonrpc_response(request_id, result: { resourceTemplates: templates })
       end
 
       def send_resource_read(id, params)
         send_jsonrpc_response(id, result: {})
       end
+
+      def log_resource_templates
+        Rails.logger.info("Registered Resource Templates: #{ActionMCP::ResourceTemplatesRegistry.resource_templates.keys}")
+      end
     end
   end
 end

data/lib/action_mcp/version.rb

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

data/lib/generators/action_mcp/install/install_generator.rb

@@ -1,17 +1,20 @@
-# frozen_string_literal: true
+require "rails/generators"
 
-module ActionMCP
+module ActionMcp
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      namespace "action_mcp:install"
       source_root File.expand_path("templates", __dir__)
-      desc "Installs both ApplicationPrompt and ApplicationTool"
-      def create_application_prompt
-        template "application_prompt.rb", "app/mcp/prompts/application_prompt.rb"
+
+      def create_application_prompt_file
+        template "application_prompt.rb", File.join("app/mcp/prompts", "application_prompt.rb")
+      end
+
+      def create_application_tool_file
+        template "application_tool.rb", File.join("app/mcp/tools", "application_tool.rb")
       end
 
-      def create_application_tool
-        template "application_tool.rb", "app/mcp/tools/application_tool.rb"
+      def create_mcp_resource_template_file
+        template "mcp_resource_template.rb", File.join("app/mcp/resource_templates", "mcp_resource_template.rb")
       end
     end
   end

data/lib/generators/action_mcp/install/templates/mcp_resource_template.rb

@@ -0,0 +1,3 @@
+class MCPResourceTemplate < ActionMcp::ResourceTemplate
+  abstract!
+end

data/lib/generators/action_mcp/resource_template/resource_template_generator.rb

@@ -0,0 +1,28 @@
+require "rails/generators"
+
+module ActionMcp
+  module Generators
+    class ResourceTemplateGenerator < Rails::Generators::NamedBase
+      namespace "action_mcp:resource_template"
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates a ResourceTemplate (in app/mcp/resource_templates) that inherits from MCPResourceTemplate"
+
+      argument :name, type: :string, required: true, banner: "ResourceTemplateName"
+
+      def create_resource_template_file
+        template "resource_template.rb.erb", "app/mcp/resource_templates/#{file_name}.rb"
+      end
+
+      private
+
+      def class_name
+        "#{name.camelize}#{name.camelize.end_with?('Template') ? '' : 'Template'}"
+      end
+
+      def file_name
+        base = name.underscore
+        base.end_with?("_template") ? base : "#{base}_template"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+class <%= class_name %> < MCPResourceTemplate
+  template_name "product"
+  description "Access product information"
+  uri_template "app://products/{product_id}"
+  mime_type "application/json"
+
+  parameter :product_id,
+            description: "Product identifier",
+            required: true
+  
+  def self.retrieve(params)
+    raise NotImplementedError, "resolve must be implemented in the subclass"
+  end
+end

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

@@ -12,6 +12,6 @@ class <%= class_name %> < ApplicationTool
 
   # Implement the tool's logic here.
   def call
-    render_text(a + b)
+    render(text: a + b)
   end
 end

data/lib/tasks/action_mcp_tasks.rake

@@ -1,4 +1,5 @@
 namespace :action_mcp do
+  # bin/rails action_mcp:list_tools
   desc "List all tools with their names and descriptions"
   task list_tools: :environment do
     # Ensure Rails eager loads all classes
@@ -7,10 +8,13 @@ namespace :action_mcp do
     puts "\e[34mACTION MCP TOOLS\e[0m"  # Blue
     puts "\e[34m---------------\e[0m"   # Blue
     ActionMCP::Tool.descendants.each do |tool|
+      next if tool.abstract?
       puts "\e[34m#{tool.capability_name}:\e[0m #{tool.description}"  # Blue name
     end
+    puts "\n"
   end
 
+  # bin/rails action_mcp:list_prompts
   desc "List all prompts with their names and descriptions"
   task list_prompts: :environment do
     # Ensure Rails eager loads all classes
@@ -19,11 +23,29 @@ namespace :action_mcp do
     puts "\e[32mACTION MCP PROMPTS\e[0m"  # Red
     puts "\e[32m-----------------\e[0m"   # Red
     ActionMCP::Prompt.descendants.each do |prompt|
+      next if prompt.abstract?
       puts "\e[32m#{prompt.capability_name}:\e[0m #{prompt.description}"  # Red name
     end
+    puts "\n"
+  end
+
+  # bin/rails action_mcp:list_resources
+  desc "List all resources with their names and descriptions"
+  task list_resources: :environment do
+    # Ensure Rails eager loads all classes
+    Rails.application.eager_load!
+
+    puts "\e[33mACTION MCP RESOURCES\e[0m"  # Yellow
+    puts "\e[33m--------------------\e[0m"   # Yellow
+    ActionMCP::ResourceTemplate.descendants.each do |resource|
+      next if resource.abstract?
+      puts "\e[33m#{resource.capability_name}:\e[0m #{resource.description}"  # Yellow name
+    end
+    puts "\n"
   end
 
   desc "List all tools and prompts with their names and descriptions"
-  task list: [ :list_tools, :list_prompts ] do
+  task list: [ :list_tools, :list_prompts, :list_resources ] do
+    # This task lists all tools, prompts, and resources
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: actionmcp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 bindir: exe
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -139,8 +139,11 @@ files:
 - lib/action_mcp/registry_base.rb
 - lib/action_mcp/renderable.rb
 - lib/action_mcp/resource.rb
+- lib/action_mcp/resource_template.rb
+- lib/action_mcp/resource_templates_registry.rb
 - lib/action_mcp/server.rb
 - lib/action_mcp/string_array.rb
+- lib/action_mcp/test_helper.rb
 - lib/action_mcp/tool.rb
 - lib/action_mcp/tools_registry.rb
 - lib/action_mcp/transport.rb
@@ -158,8 +161,11 @@ files:
 - lib/generators/action_mcp/install/install_generator.rb
 - lib/generators/action_mcp/install/templates/application_prompt.rb
 - lib/generators/action_mcp/install/templates/application_tool.rb
+- lib/generators/action_mcp/install/templates/mcp_resource_template.rb
 - lib/generators/action_mcp/prompt/prompt_generator.rb
 - lib/generators/action_mcp/prompt/templates/prompt.rb.erb
+- lib/generators/action_mcp/resource_template/resource_template_generator.rb
+- lib/generators/action_mcp/resource_template/templates/resource_template.rb.erb
 - lib/generators/action_mcp/tool/templates/tool.rb.erb
 - lib/generators/action_mcp/tool/tool_generator.rb
 - lib/tasks/action_mcp_tasks.rake