actionmcp 0.80.1 → 0.82.0

data/lib/action_mcp/tool.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "action_mcp/types/float_array_type"
+require "action_mcp/schema_helpers"
 
 module ActionMCP
   # Base class for defining tools.
@@ -10,6 +11,7 @@ module ActionMCP
   class Tool < Capability
     include ActionMCP::Callbacks
     include ActionMCP::CurrentHelpers
+    extend ActionMCP::SchemaHelpers
 
     # --------------------------------------------------------------------------
     # Class Attributes for Tool Metadata and Schema
@@ -24,6 +26,9 @@ module ActionMCP
     class_attribute :_output_schema, instance_accessor: false, default: nil
     class_attribute :_meta, instance_accessor: false, default: {}
     class_attribute :_requires_consent, instance_accessor: false, default: false
+    class_attribute :_output_schema_builder, instance_accessor: false, default: nil
+    class_attribute :_additional_properties, instance_accessor: false, default: nil
+    class_attribute :_cached_schema_property_keys, instance_accessor: false, default: nil
 
     # --------------------------------------------------------------------------
     # Tool Name and Description DSL
@@ -126,10 +131,27 @@ module ActionMCP
         _annotations["openWorldHint"] == true
       end
 
-      # Sets the output schema for structured content
-      def output_schema(schema = nil)
+
+      # Schema DSL for output structure
+      # @param block [Proc] Block containing output schema definition
+      # @return [Hash] The generated JSON Schema
+      def output_schema(&block)
+        return _output_schema unless block_given?
+
+        builder = OutputSchemaBuilder.new
+        builder.instance_eval(&block)
+
+        # Store both the builder and the generated schema
+        self._output_schema_builder = builder
+        self._output_schema = builder.to_json_schema
+
+        _output_schema
+      end
+
+      # Legacy output_schema method for backward compatibility
+      def output_schema_legacy(schema = nil)
         if schema
-          raise NotImplementedError, "Output schema DSL not yet implemented. Coming soon with structured content DSL!"
+          raise NotImplementedError, "Legacy output schema not yet implemented. Use output_schema DSL instead!"
         end
 
         _output_schema
@@ -155,6 +177,45 @@ module ActionMCP
       def requires_consent?
         _requires_consent
       end
+
+      # Sets or retrieves the additionalProperties setting for the input schema
+      # @param enabled [Boolean, Hash] true to allow any additional properties,
+      #   false to disallow them, or a Hash for typed additional properties
+      def additional_properties(enabled = nil)
+        if enabled.nil?
+          _additional_properties
+        else
+          self._additional_properties = enabled
+        end
+      end
+
+      # Returns whether this tool accepts additional properties
+      def accepts_additional_properties?
+        !_additional_properties.nil? && _additional_properties != false
+      end
+
+      # Returns cached string keys for schema properties to avoid repeated conversions
+      def schema_property_keys
+        return _cached_schema_property_keys if _cached_schema_property_keys
+
+        self._cached_schema_property_keys = _schema_properties.keys.map(&:to_s)
+        _cached_schema_property_keys
+      end
+
+      # Clear cached keys when properties change - use metaprogramming to avoid duplication
+      [ :property, :collection ].each do |method_name|
+        define_method(method_name) do |prop_name, **opts|
+          invalidate_schema_cache
+          super(prop_name, **opts)
+        end
+      end
+
+      private
+
+      # Invalidate cached schema property keys
+      def invalidate_schema_cache
+        self._cached_schema_property_keys = nil
+      end
     end
 
     # --------------------------------------------------------------------------
@@ -245,6 +306,9 @@ module ActionMCP
       }
       schema[:required] = _required_properties if _required_properties.any?
 
+      # Add additionalProperties if configured
+      add_additional_properties_to_schema(schema, _additional_properties)
+
       result = {
         name: tool_name,
         description: description.presence,
@@ -270,11 +334,29 @@ module ActionMCP
 
     # Override initialize to validate parameters before ActiveModel conversion
     def initialize(attributes = {})
+      # Separate additional properties from defined attributes if enabled
+      if self.class.accepts_additional_properties?
+        defined_keys = self.class.schema_property_keys
+        # Use partition for single-pass separation - more efficient than except/slice
+        defined_attrs, additional_attrs = attributes.partition { |k, _|
+          defined_keys.include?(k.to_s)
+        }.map(&:to_h)
+        @_additional_params = additional_attrs
+        attributes = defined_attrs
+      else
+        @_additional_params = {}
+      end
+
       # Validate parameters before ActiveModel processes them
       validate_parameter_types(attributes)
       super
     end
 
+    # Returns additional parameters that were passed but not defined in the schema
+    def additional_params
+      @_additional_params || {}
+    end
+
     # Public entry point for executing the tool
     # Returns an array of Content objects collected from render calls
     def call
@@ -290,9 +372,9 @@ module ActionMCP
         rescue StandardError => e
           # Show generic error message for HTTP requests, detailed for direct calls
           error_message = if execution_context[:request].present?
-                            "An unexpected error occurred."
+                             "An unexpected error occurred."
           else
-                            e.message
+            e.message
           end
           @response.mark_as_error!(:internal_error, message: error_message)
         end
@@ -327,11 +409,18 @@ module ActionMCP
       end.join(', ')}, #{response_info}#{errors_info}>"
     end
 
-    # Override render to collect Content objects
-    def render(**args)
-      content = super(**args) # Call Renderable's render method
-      @response.add(content)  # Add to the response
-      content # Return the content for potential use in perform
+    # Override render to collect Content objects and support structured content
+    def render(structured: nil, **args)
+      if structured
+        # Render structured content
+        set_structured_content(structured)
+        structured
+      else
+        # Normal content rendering
+        content = super(**args) # Call Renderable's render method
+        @response.add(content)  # Add to the response
+        content # Return the content for potential use in perform
+      end
     end
 
     # Override render_resource_link to collect ResourceLink objects
@@ -352,25 +441,21 @@ module ActionMCP
     private
 
     # Helper method for tools to manually report errors
+    # Uses the MCP-compliant tool execution error format
     def report_error(message)
-      @response.mark_as_error!
-      render text: message
+      @response.report_tool_error(message)
     end
 
     # Helper method to set structured content
     def set_structured_content(content)
       return unless @response
 
-      # Validate against output schema if defined
-      # TODO: Add JSON Schema validation here
-      # For now, just ensure it's a hash/object
-      if self.class._output_schema && !content.is_a?(Hash)
-        raise ArgumentError, "Structured content must be a hash/object when output_schema is defined"
-      end
-
       @response.set_structured_content(content)
     end
 
+    private
+
+
     # Maps a JSON Schema type to an ActiveModel attribute type.
     #
     # @param type [String] The JSON Schema type.

data/lib/action_mcp/tool_response.rb

@@ -3,7 +3,7 @@
 module ActionMCP
   # Manages the collection of content objects for tool results
   class ToolResponse < BaseResponse
-    attr_reader :contents, :structured_content
+    attr_reader :contents, :structured_content, :tool_execution_error
 
     delegate :empty?, :size, :each, :find, :map, to: :contents
 
@@ -11,6 +11,7 @@ module ActionMCP
       super
       @contents = []
       @structured_content = nil
+      @tool_execution_error = false  # Track if this is a tool execution error
     end
 
     # Add content to the response
@@ -24,6 +25,26 @@ module ActionMCP
       @structured_content = content
     end
 
+    # Report a tool execution error (as opposed to protocol error)
+    # This follows MCP spec for tool execution errors
+    def report_tool_error(message)
+      @tool_execution_error = true
+      add(Content::Text.new(message))
+    end
+
+    def to_h(_options = nil)
+      if @tool_execution_error
+        result = {
+          isError: true,
+          content: @contents.map(&:to_h)
+        }
+        result[:structuredContent] = @structured_content if @structured_content
+        result
+      else
+        super
+      end
+    end
+
     # Implementation of build_success_hash for ToolResponse
     def build_success_hash
       result = {
@@ -35,12 +56,14 @@ module ActionMCP
 
     # Implementation of compare_with_same_class for ToolResponse
     def compare_with_same_class(other)
-      contents == other.contents && is_error == other.is_error && structured_content == other.structured_content
+      contents == other.contents && is_error == other.is_error &&
+        structured_content == other.structured_content &&
+        tool_execution_error == other.tool_execution_error
     end
 
     # Implementation of hash_components for ToolResponse
     def hash_components
-      [ contents, is_error, structured_content ]
+      [ contents, is_error, structured_content, tool_execution_error ]
     end
 
     # Pretty print for better debugging

data/lib/action_mcp/version.rb

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

data/lib/action_mcp.rb

@@ -31,7 +31,6 @@ end.setup
 module ActionMCP
   require_relative "action_mcp/version"
   require_relative "action_mcp/client"
-  include Logging
 
   # Protocol version constants
   SUPPORTED_VERSIONS = [

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

@@ -32,8 +32,19 @@ class <%= class_name %> < ApplicationMCPTool
     <% end %>
     <% end %>
 
+  # Uncomment to allow additional properties beyond those defined above:
+  # additional_properties true           # Allow any additional properties
+  # additional_properties false          # Explicitly disallow additional properties 
+  # additional_properties({"type" => "string"})  # Allow additional properties but restrict to strings
+
   def perform
     render(text: "Processing <%= properties.map { |p| p[:name] }.join(', ') %>")
+    
+    # If additional_properties is enabled, you can access extra parameters:
+    # extra_params = additional_params
+    # extra_params.each do |key, value|
+    #   render(text: "Additional #{key}: #{value}")
+    # end
 
     # Optional outputs:
     # render(audio: "<base64_data>", mime_type: "audio/mpeg")
@@ -41,6 +52,6 @@ class <%= class_name %> < ApplicationMCPTool
     # render(resource: "file://path", mime_type: "application/json", text: "{}")
     # render(resource: "file://path", mime_type: "application/octet-stream", blob: "<base64_data>")
   rescue => e
-    render(error: ["Error: #{e.message}"])
+    report_error("Error: #{e.message}")
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actionmcp
 version: !ruby/object:Gem::Version
-  version: 0.80.1
+  version: 0.82.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -206,6 +206,12 @@ files:
 - lib/action_mcp/json_rpc_handler_base.rb
 - lib/action_mcp/log_subscriber.rb
 - lib/action_mcp/logging.rb
+- lib/action_mcp/logging/level.rb
+- lib/action_mcp/logging/logger.rb
+- lib/action_mcp/logging/mixin.rb
+- lib/action_mcp/logging/null_logger.rb
+- lib/action_mcp/logging/state.rb
+- lib/action_mcp/output_schema_builder.rb
 - lib/action_mcp/prompt.rb
 - lib/action_mcp/prompt_response.rb
 - lib/action_mcp/prompts_registry.rb
@@ -216,6 +222,7 @@ files:
 - lib/action_mcp/resource_response.rb
 - lib/action_mcp/resource_template.rb
 - lib/action_mcp/resource_templates_registry.rb
+- lib/action_mcp/schema_helpers.rb
 - lib/action_mcp/server.rb
 - lib/action_mcp/server/active_record_session_store.rb
 - lib/action_mcp/server/base_messaging.rb
@@ -226,6 +233,7 @@ files:
 - lib/action_mcp/server/elicitation.rb
 - lib/action_mcp/server/error_aware.rb
 - lib/action_mcp/server/error_handling.rb
+- lib/action_mcp/server/handlers/logging_handler.rb
 - lib/action_mcp/server/handlers/prompt_handler.rb
 - lib/action_mcp/server/handlers/resource_handler.rb
 - lib/action_mcp/server/handlers/router.rb