active_mcp 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 862fda276ef5442ec0c9ee381134e33ce27b1dd797d386db7db95defc29fa1ee
-  data.tar.gz: 2d7892d5eceb1acc3643451e3786cc208cfa1fea1e4b440b05b6ec5a5c440ac8
+  metadata.gz: 8c67705b1452f86930b120080e883a10cdb4d231bf2a8a533621adb55b3099c6
+  data.tar.gz: 62d30c1eba1c08c25b6c0e8a74337e3c735a3d14fe85c8f81a19505a0db248cd
 SHA512:
-  metadata.gz: b14998a48988aef825e41603d34a3ec571df2ffb5dff804494ecfe137f4fadc138d55b462580dca5097341bc098fab890d1fe8456a90c29ee25b64a6337cf8d3
-  data.tar.gz: ab594bcf8c596d1f6f47c93f3a1c14163113b2767fb2dd9fb64cb9c92d97799144819d0b8870242562e02069c19fcee3eb0cde660b2c42c64f2783a35a300a4f
+  metadata.gz: ce288f544ec46e5a5c44da9651c344fa985e17b730dbd463230cb86143f1bb8ddd2992c64219ee3eacb9dc3264820ae1b92d4c751938dd01dcac5ac3b2a6d2e0
+  data.tar.gz: 9709e2ce17bbe2f86fd3e15a3ecee1748a7708b69b5ecf79843cd94a342fabb1009563d2651d0d8377f0335c663e9d9e26b3017587d33d1fdb3ab7e580577aca

data/README.md

@@ -59,8 +59,8 @@ end
 class CreateNoteTool < ActiveMcp::Tool
   description "Create Note!!"
 
-  property :title, :string
-  property :content, :string
+  argument :title, :string
+  argument :content, :string
 
   def call(title:, content:)
     Note.create(title:, content:)
@@ -129,8 +129,8 @@ This creates a new tool file at `app/tools/search_users_tool.rb` with the follow
 class SearchUsersTool < ActiveMcp::Tool
   description 'Search users'
 
-  property :param1, :string, required: true, description: 'First parameter description'
-  property :param2, :string, required: false, description: 'Second parameter description'
+  argument :param1, :string, required: true, description: 'First parameter description'
+  argument :param2, :string, required: false, description: 'Second parameter description'
   # Add more parameters as needed
 
   def call(param1:, param2: nil, auth_info: nil, **args)
@@ -147,10 +147,10 @@ You can then customize the generated tool to fit your needs.
 ## Input Schema
 
 ```ruby
-property :name, :string, required: true, description: 'User name'
-property :age, :integer, required: false, description: 'User age'
-property :addresses, :array, required: false, description: 'User addresses'
-property :preferences, :object, required: false, description: 'User preferences'
+argument :name, :string, required: true, description: 'User name'
+argument :age, :integer, required: false, description: 'User age'
+argument :addresses, :array, required: false, description: 'User addresses'
+argument :preferences, :object, required: false, description: 'User preferences'
 ```
 
 Supported types include:
@@ -179,16 +179,16 @@ ActiveMcp supports both authentication (verifying who a user is) and authorizati
 
 ### Authorization for Tools
 
-You can control which tools are visible and accessible to different users by overriding the `authorized?` class method:
+You can control which tools are visible and accessible to different users by overriding the `visible?` class method:
 
 ```ruby
 class AdminOnlyTool < ActiveMcp::Tool
   description "This tool is only accessible by admins"
 
-  property :command, :string, required: true, description: "Admin command to execute"
+  argument :command, :string, required: true, description: "Admin command to execute"
 
   # Define authorization logic - only admin tokens can access this tool
-  def self.authorized?(auth_info)
+  def self.visible?(auth_info)
     return false unless auth_info
     return false unless auth_info[:type] == :bearer
 
@@ -274,7 +274,7 @@ Authentication information is automatically passed to your tools through the `au
 class SecuredDataTool < ActiveMcp::Tool
   description 'Access secured data'
 
-  property :resource_id, :string, required: true, description: 'ID of the resource to access'
+  argument :resource_id, :string, required: true, description: 'ID of the resource to access'
 
   def call(resource_id:, auth_info: nil, **args)
     # Check if auth info exists
@@ -345,9 +345,9 @@ For example, instead of creating a generic search tool, create specific search t
 class SearchUsersTool < ActiveMcp::Tool
   description 'Search users by criteria'
 
-  property :email, :string, required: false, description: 'Email to search for'
-  property :name, :string, required: false, description: 'Name to search for'
-  property :limit, :integer, required: false, description: 'Maximum number of records to return'
+  argument :email, :string, required: false, description: 'Email to search for'
+  argument :name, :string, required: false, description: 'Name to search for'
+  argument :limit, :integer, required: false, description: 'Maximum number of records to return'
 
   def call(email: nil, name: nil, limit: 10)
     criteria = {}
@@ -367,9 +367,9 @@ end
 class SearchPostsTool < ActiveMcp::Tool
   description 'Search posts by criteria'
 
-  property :title, :string, required: false, description: 'Title to search for'
-  property :author_id, :integer, required: false, description: 'Author ID to filter by'
-  property :limit, :integer, required: false, description: 'Maximum number of records to return'
+  argument :title, :string, required: false, description: 'Title to search for'
+  argument :author_id, :integer, required: false, description: 'Author ID to filter by'
+  argument :limit, :integer, required: false, description: 'Maximum number of records to return'
 
   def call(title: nil, author_id: nil, limit: 10)
     criteria = {}

data/app/controllers/active_mcp/base_controller.rb

@@ -2,72 +2,6 @@
 
 module ActiveMcp
   class BaseController < ActionController::Base
-    protect_from_forgery with: :null_session
-    skip_before_action :verify_authenticity_token
-    before_action :authenticate, only: [:index]
-
-    def index
-      if params[:jsonrpc]
-        process_request_from_mcp_client
-      else
-        process_request_from_mcp_server
-      end
-    end
-
-    private
-
-    def process_request_from_mcp_server
-      case params[:method]
-      when Method::TOOLS_LIST
-        result = Response::ToolsList::Json.call(
-          tools: Response::Tools.to_hash(auth_info: @auth_info)
-        )
-      when Method::TOOLS_CALL
-        result = Response::ToolsCall::Json.call(params:, auth_info: @auth_info)
-      else
-        result = Response::NoMethod.call
-      end
-
-      render json: result, status: 200
-    end
-
-    def process_request_from_mcp_client
-      case params[:method]
-      when Method::INITIALIZE
-        result = Response::Initialize.call(id: params[:id])
-      when Method::INITIALIZED
-        result = Response::Initialized.call
-      when Method::CANCELLED
-        result = Response::Cancelled.call
-      when Method::TOOLS_LIST
-        result = Response::ToolsList::Jsonrpc.call(
-          id: params[:id],
-          tools: Response::Tools.to_hash(auth_info: @auth_info)
-        )
-      when Method::TOOLS_CALL
-        result = Response::ToolsCall::Jsonrpc.call(id: params[:id], params:, auth_info: @auth_info)
-      else
-        result = Response::NoMethod.call
-      end
-
-      render json: result, status: 200
-    end
-
-    def authenticate
-      auth_header = request.headers["Authorization"]
-      if auth_header.present?
-        @auth_info = {
-          header: auth_header,
-          type: if auth_header.start_with?("Bearer ")
-                  :bearer
-                elsif auth_header.start_with?("Basic ")
-                  :basic
-                else
-                  :unknown
-                end,
-          token: auth_header.split(" ").last
-        }
-      end
-    end
+    include RequestHandler
   end
 end

data/app/controllers/concerns/active_mcp/request_handler.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module ActiveMcp
+  module RequestHandler
+    extend ActiveSupport::Concern
+
+    included do
+      protect_from_forgery with: :null_session
+      skip_before_action :verify_authenticity_token
+      before_action :authenticate, only: [:index]
+    end
+
+    def index
+      if json_rpc_request?
+        handle_mcp_client_request
+      else
+        handle_mcp_server_request
+      end
+    end
+
+    private
+
+    def json_rpc_request?
+      params[:jsonrpc].present?
+    end
+
+    def handle_mcp_client_request
+      @id = params[:id]
+      @auth_info = auth_info
+      
+      case params[:method]
+      when Method::INITIALIZE
+        render 'active_mcp/initialize', formats: :json
+      when Method::INITIALIZED
+        render 'active_mcp/initialized', formats: :json
+      when Method::CANCELLED
+        render 'active_mcp/cancelled', formats: :json
+      when Method::TOOLS_LIST
+        @tools = ActiveMcp::Tool.authorized_tools(auth_info)
+        @format = :jsonrpc
+        render 'active_mcp/tools_list', formats: :json
+      when Method::TOOLS_CALL
+        @tool_result = ActiveMcp::ToolExecutor.execute(params: params, auth_info: auth_info)
+        @format = :jsonrpc
+        render 'active_mcp/tools_call', formats: :json
+      else
+        @format = :jsonrpc
+        render 'active_mcp/no_method', formats: :json
+      end
+    end
+
+    def handle_mcp_server_request
+      @auth_info = auth_info
+      
+      case params[:method]
+      when Method::TOOLS_LIST
+        @tools = ActiveMcp::Tool.authorized_tools(auth_info)
+        @format = :json
+        render 'active_mcp/tools_list', formats: :json
+      when Method::TOOLS_CALL
+        @tool_result = ActiveMcp::ToolExecutor.execute(params: params, auth_info: auth_info)
+        @format = :json
+        render 'active_mcp/tools_call', formats: :json
+      else
+        @format = :json
+        render 'active_mcp/no_method', formats: :json
+      end
+    end
+
+    def authenticate
+      auth_header = request.headers["Authorization"]
+      if auth_header.present?
+        @auth_info = {
+          header: auth_header,
+          type: if auth_header.start_with?("Bearer ")
+                  :bearer
+                elsif auth_header.start_with?("Basic ")
+                  :basic
+                else
+                  :unknown
+                end,
+          token: auth_header.split(" ").last
+        }
+      end
+    end
+
+    def auth_info
+      @auth_info
+    end
+  end
+end

data/app/models/active_mcp/tool_executor.rb

@@ -1,8 +1,14 @@
 module ActiveMcp
-  module ToolExecutor
-    def self.call(params:, auth_info:)
-      tool_name = params[:name]
-
+  class ToolExecutor
+    def self.execute(params:, auth_info:)
+      if params[:jsonrpc].present?
+        tool_name = params[:params][:name]
+        tool_params = params[:params][:arguments]
+      else
+        tool_name = params[:name]
+        tool_params = params[:arguments]
+      end
+      
       unless tool_name
         return {
           isError: true,
@@ -18,7 +24,7 @@ module ActiveMcp
       tool_class = Tool.registered_tools.find do |tc|
         tc.tool_name == tool_name
       end
-
+      
       unless tool_class
         return {
           isError: true,
@@ -30,8 +36,8 @@ module ActiveMcp
           ]
         }
       end
-
-      unless tool_class.authorized?(auth_info)
+      
+      unless tool_class.visible?(auth_info)
         return {
           isError: true,
           content: [
@@ -43,12 +49,16 @@ module ActiveMcp
         }
       end
 
-      arguments = params[:arguments].permit!.to_hash.symbolize_keys.transform_values do |value|
-        if !value.is_a?(String)
-          value
-        else
-          value.match(/^\d+$/) ? value.to_i : value
+      if tool_params
+        arguments = tool_params.permit!.to_hash.symbolize_keys.transform_values do |value|
+          if !value.is_a?(String)
+            value
+          else
+            value.match(/^\d+$/) ? value.to_i : value
+          end
         end
+      else
+        arguments = {}
       end
 
       tool = tool_class.new
@@ -65,10 +75,11 @@ module ActiveMcp
           ]
         }
       end
-
+      
+      # Execute the tool
       begin
         arguments[:auth_info] = auth_info if auth_info.present?
-
+        
         return {
           content: [
             {
@@ -89,7 +100,7 @@ module ActiveMcp
         }
       end
     end
-
+    
     def self.formatted(object)
       case object
       when String

data/app/views/active_mcp/cancelled.json.jbuilder

@@ -0,0 +1,2 @@
+json.jsonrpc ActiveMcp::JSON_RPC_VERSION
+json.result true

data/app/views/active_mcp/initialize.json.jbuilder

@@ -0,0 +1,21 @@
+json.jsonrpc ActiveMcp::JSON_RPC_VERSION
+json.id @id
+json.result do
+  json.protocolVersion ActiveMcp::PROTOCOL_VERSION
+  json.capabilities do
+    json.logging Hash.new
+    json.capabilities do
+      json.resources do
+        json.subscribe false
+        json.listChanged false
+      end
+      json.tools do
+        json.listChanged false
+      end
+    end
+  end
+  json.serverInfo do
+    json.name ActiveMcp.config.respond_to?(:server_name) ? ActiveMcp.config.server_name : "Active MCP Server"
+    json.version ActiveMcp.config.respond_to?(:server_version) ? ActiveMcp.config.server_version : ActiveMcp::VERSION
+  end
+end

data/app/views/active_mcp/initialized.json.jbuilder

@@ -0,0 +1,2 @@
+json.jsonrpc ActiveMcp::JSON_RPC_VERSION
+json.method ActiveMcp::Method::INITIALIZED

data/app/views/active_mcp/no_method.json.jbuilder

@@ -0,0 +1,4 @@
+json.jsonrpc ActiveMcp::JSON_RPC_VERSION if @format == :jsonrpc
+json.id @id if @format == :jsonrpc && @id.present?
+
+json.error "Method not found"

data/app/views/active_mcp/tools_call.json.jbuilder

@@ -0,0 +1,9 @@
+json.jsonrpc ActiveMcp::JSON_RPC_VERSION if @format == :jsonrpc
+json.id @id if @format == :jsonrpc && @id.present?
+
+if @format == :jsonrpc
+  json.result @tool_result
+else
+  json.isError @tool_result[:isError] if @tool_result[:isError]
+  json.content @tool_result[:content]
+end

data/app/views/active_mcp/tools_list.json.jbuilder

@@ -0,0 +1,10 @@
+json.jsonrpc ActiveMcp::JSON_RPC_VERSION if @format == :jsonrpc
+json.id @id if @format == :jsonrpc && @id.present?
+
+if @format == :jsonrpc
+  json.result do
+    json.tools @tools
+  end
+else
+  json.result @tools
+end

data/lib/active_mcp/engine.rb

@@ -10,5 +10,12 @@ module ActiveMcp
         end
       end
     end
+    
+    initializer "active_mcp.configure_jbuilder" do |app|
+      if Rails.env.development?
+        Jbuilder.key_format camelize: :lower
+        Jbuilder.prettify if Jbuilder.respond_to?(:prettify) 
+      end
+    end
   end
 end

data/lib/active_mcp/tool.rb

@@ -25,6 +25,10 @@ module ActiveMcp
         @schema["required"] << name.to_s if required
       end
 
+      def argument(...)
+        property(...)
+      end
+
       def registered_tools
         @registered_tools ||= []
       end
@@ -35,8 +39,24 @@ module ActiveMcp
         registered_tools << subclass
       end
 
-      def authorized?(auth_info)
-        true
+      def visible?(auth_info)
+        if respond_to?(:authorized?)
+          authorized?(auth_info)
+        else
+          true
+        end
+      end
+      
+      def authorized_tools(auth_info = nil)
+        registered_tools.select do |tool_class|
+          tool_class.visible?(auth_info)
+        end.map do |tool_class|
+          {
+            name: tool_class.tool_name,
+            description: tool_class.desc,
+            inputSchema: tool_class.schema
+          }
+        end
       end
     end
 

data/lib/active_mcp/version.rb

@@ -1,3 +1,3 @@
 module ActiveMcp
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

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

@@ -1,13 +1,13 @@
 class <%= class_name %> < ActiveMcp::Tool
   description "<%= file_name.humanize %>"
   
-  property :param1, :string, required: true, description: "First parameter description"
-  property :param2, :string, required: false, description: "Second parameter description"
+  argument :param1, :string, required: true, description: "First parameter description"
+  argument :param2, :string, required: false, description: "Second parameter description"
   # Add more parameters as needed
   
   # Uncomment and modify this method to implement authorization control
   # This controls who can see and use this tool
-  # def self.authorized?(auth_info)
+  # def self.visible?(auth_info)
   #   # Example: require authentication
   #   # return false unless auth_info
   #   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_mcp
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Moeki Kawakami
@@ -43,6 +43,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: A Rails engine that provides MCP capabilities to your Rails application
 email:
 - hi@moeki.org
@@ -54,16 +68,14 @@ files:
 - README.md
 - Rakefile
 - app/controllers/active_mcp/base_controller.rb
-- app/models/active_mcp/response/cancelled.rb
-- app/models/active_mcp/response/initialize.rb
-- app/models/active_mcp/response/initialized.rb
-- app/models/active_mcp/response/no_method.rb
-- app/models/active_mcp/response/tools.rb
-- app/models/active_mcp/response/tools_call/json.rb
-- app/models/active_mcp/response/tools_call/jsonrpc.rb
-- app/models/active_mcp/response/tools_list/json.rb
-- app/models/active_mcp/response/tools_list/jsonrpc.rb
+- app/controllers/concerns/active_mcp/request_handler.rb
 - app/models/active_mcp/tool_executor.rb
+- app/views/active_mcp/cancelled.json.jbuilder
+- app/views/active_mcp/initialize.json.jbuilder
+- app/views/active_mcp/initialized.json.jbuilder
+- app/views/active_mcp/no_method.json.jbuilder
+- app/views/active_mcp/tools_call.json.jbuilder
+- app/views/active_mcp/tools_list.json.jbuilder
 - config/routes.rb
 - lib/active_mcp.rb
 - lib/active_mcp/configuration.rb

data/app/models/active_mcp/response/cancelled.rb

@@ -1,12 +0,0 @@
-module ActiveMcp
-  module Response
-    class Cancelled
-      def self.call
-        {
-          jsonrpc: JSON_RPC_VERSION,
-          method: Method::CANCELLED
-        }
-      end
-    end
-  end
-end

data/app/models/active_mcp/response/initialize.rb

@@ -1,31 +0,0 @@
-module ActiveMcp
-  module Response
-    class Initialize
-      def self.call(id:)
-        {
-          jsonrpc: JSON_RPC_VERSION,
-          id:,
-          result: {
-            protocolVersion: PROTOCOL_VERSION,
-            capabilities: {
-              logging: {},
-              capabilities: {
-                resources: {
-                  subscribe: false,
-                  listChanged: false
-                },
-                tools: {
-                  listChanged: false
-                }
-              },
-            },
-            serverInfo: {
-              name: ActiveMcp.config.server_name,
-              version: ActiveMcp.config.server_version
-            }
-          }
-        }
-      end
-    end
-  end
-end

data/app/models/active_mcp/response/initialized.rb

@@ -1,12 +0,0 @@
-module ActiveMcp
-  module Response
-    class Initialized
-      def self.call
-        {
-          jsonrpc: JSON_RPC_VERSION,
-          method: Method::INITIALIZED
-        }
-      end
-    end
-  end
-end

data/app/models/active_mcp/response/no_method.rb

@@ -1,11 +0,0 @@
-module ActiveMcp
-  module Response
-    class NoMethod
-      def self.call
-        {
-          error: "Method not found"
-        }
-      end
-    end
-  end
-end

data/app/models/active_mcp/response/tools.rb

@@ -1,17 +0,0 @@
-module ActiveMcp
-  module Response
-    class Tools
-      def self.to_hash(auth_info:)
-        Tool.registered_tools.select do |tool_class|
-          tool_class.authorized?(auth_info)
-        end.map do |tool_class|
-          {
-            name: tool_class.tool_name,
-            description: tool_class.desc,
-            inputSchema: tool_class.schema
-          }
-        end
-      end
-    end
-  end
-end

data/app/models/active_mcp/response/tools_call/json.rb

@@ -1,11 +0,0 @@
-module ActiveMcp
-  module Response
-    module ToolsCall
-      class Json
-        def self.call(params:, auth_info:)
-          ActiveMcp::ToolExecutor.call(params:, auth_info:)
-        end
-      end
-    end
-  end
-end

data/app/models/active_mcp/response/tools_call/jsonrpc.rb

@@ -1,16 +0,0 @@
-module ActiveMcp
-  module Response
-    module ToolsCall
-      class Jsonrpc
-        def self.call(id:, params:, auth_info:)
-          result = ActiveMcp::ToolExecutor.call(params: params[:params], auth_info:)
-          {
-            jsonrpc: JSON_RPC_VERSION,
-            id:,
-            result:
-          }
-        end
-      end
-    end
-  end
-end

data/app/models/active_mcp/response/tools_list/json.rb

@@ -1,13 +0,0 @@
-module ActiveMcp
-  module Response
-    module ToolsList
-      class Json
-        def self.call(tools:)
-          {
-            result: tools
-          }
-        end
-      end
-    end
-  end
-end

data/app/models/active_mcp/response/tools_list/jsonrpc.rb

@@ -1,15 +0,0 @@
-module ActiveMcp
-  module Response
-    module ToolsList
-      class Jsonrpc
-        def self.call(id:, tools:)
-          {
-            jsonrpc: JSON_RPC_VERSION,
-            id:,
-            result: {tools:}
-          }
-        end
-      end
-    end
-  end
-end