active_mcp 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f94cddd4a196e9f5d1b0501457cb9d318fe1a32cfb997391f0b428f42b850813
-  data.tar.gz: de38f78d65269af6441c9f375ebca7ae2372acbee26c87ac04d68815a844da07
+  metadata.gz: 791510bf59750086b139e1688d8cfd7367c635a359f2dfe2678756e612a20816
+  data.tar.gz: 320cb00fa8a75622a667260477c479fd1c9df653e54af85238dc77384923b0a9
 SHA512:
-  metadata.gz: 17f8847a39433c08b61838f416dfa6f3e0aecce6daf6ef8051dffdb5e71ac58f191c7654080570f18aae88b002219efd06a260d3afd26d7d1724a5758abf8746
-  data.tar.gz: afc770724f80df1f92929ab69c88577a6a0e974ad0647acf2dbdf677c7d6dc5b0a01f8792d53ef7eac818a72e11346769f13cd64f6651cc6375ba1bb544c8099
+  metadata.gz: d65ba7458c1718d59d8b718eb8422192a1b520e72f877427feb4bdcb9057f9350718ebc8e4687eb7cc05f447962d728949cef94ed2c90937d82deb5ea3fc0727
+  data.tar.gz: 54ed82f6c351d9e91e4e4108ed27767564c84d7d0bfc65a101598c0cdc5b879c70aa1b926d2e5c60a8181372a88ad6e9049a7232242726607ae65f58b9585816

data/README.md

@@ -2,8 +2,6 @@
 
 A Ruby on Rails engine that provides [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) capabilities to Rails applications. This gem allows you to easily create and expose MCP-compatible tools from your Rails application.
 
-![Active MCP](./docs/active_mcp.png)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,6 +24,25 @@ $ gem install active_mcp
 
 ## Setup
 
+### Using the Install Generator (Recommended)
+
+The easiest way to set up Active MCP in your Rails application is to use the install generator:
+
+```bash
+$ rails generate active_mcp:install
+```
+
+This generator will:
+
+1. Create a configuration initializer at `config/initializers/active_mcp.rb`
+2. Mount the ActiveMcp engine in your routes
+
+After running the generator, follow the displayed instructions to create and configure your MCP tools.
+
+### Manual Setup
+
+If you prefer to set up manually:
+
 1. Mount the ActiveMcp engine in your `config/routes.rb`:
 
 ```ruby
@@ -53,7 +70,13 @@ class CreateNoteTool < ActiveMcp::Tool
 end
 ```
 
-3. Start the MCP server:
+#### with streamable HTTP
+
+Set MCP destination to `https:your-app.example.com/mcp`
+
+#### with independent MCP Server
+
+Start the MCP server:
 
 ```ruby
 # server.rb
@@ -64,7 +87,7 @@ server = ActiveMcp::Server.new(
 server.start
 ```
 
-4. Set up MCP Client
+Set up MCP Client
 
 ```json
 {
@@ -79,14 +102,28 @@ server.start
 
 ## Rails Generators
 
-MCP Rails provides generators to help you quickly create new MCP tools:
+Active MCP provides generators to help you quickly set up and extend your MCP integration:
+
+### Install Generator
+
+Initialize Active MCP in your Rails application:
+
+```bash
+$ rails generate active_mcp:install
+```
+
+This sets up all necessary configuration files and mounts the MCP engine in your routes.
+
+### Tool Generator
+
+Create new MCP tools quickly:
 
 ```bash
 # Generate a new MCP tool
 $ rails generate active_mcp:tool search_users
 ```
 
-This creates a new tool file at `app/models/tools/search_users_tool.rb` with the following starter code:
+This creates a new tool file at `app/tools/search_users_tool.rb` with the following starter code:
 
 ```ruby
 class SearchUsersTool < ActiveMcp::Tool
@@ -154,7 +191,7 @@ class AdminOnlyTool < ActiveMcp::Tool
   def self.authorized?(auth_info)
     return false unless auth_info
     return false unless auth_info[:type] == :bearer
-    
+
     # Check if the token belongs to an admin
     auth_info[:token] == "admin-token" || User.find_by_token(auth_info[:token])&.admin?
   end
@@ -166,6 +203,7 @@ end
 ```
 
 When a user makes a request to the MCP server:
+
 1. Only tools that return `true` from their `authorized?` method will be included in the tools list
 2. Users can only call tools that they're authorized to use
 3. Unauthorized access attempts will return a 403 Forbidden response

data/app/controllers/active_mcp/base_controller.rb

@@ -8,13 +8,30 @@ module ActiveMcp
 
     def index
       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
-        render_tools_list
+        tools = Response::Tools.to_hash(auth_info: @auth_info)
+        if params[:jsonrpc]
+          result = Response::ToolsList::Jsonrpc.call(id: params[:id], tools:)
+        else
+          result = Response::ToolsList::Json.call(tools:)
+        end
       when Method::TOOLS_CALL
-        call_tool(params)
+        if params[:jsonrpc]
+          result = Response::ToolsCall::Jsonrpc.call(id: params[:id], params:, auth_info: @auth_info)
+        else
+          result = Response::ToolsCall::Json.call(params:, auth_info: @auth_info)
+        end
       else
-        render json: {error: "Method not found: #{params[:method]}"}, status: 404
+        result = Response::NoMethod.call
       end
+
+      render json: result[:body], status: result[:status]
     end
 
     private
@@ -35,63 +52,5 @@ module ActiveMcp
         }
       end
     end
-
-    def render_tools_list
-      # 認可チェックを含めてツールリストをフィルタリング
-      tools = Tool.registered_tools.select do |tool_class|
-        # 認可チェック - ツールがauthorized?メソッドでtrueを返すもののみを選択
-        tool_class.authorized?(@auth_info)
-      end.map do |tool_class|
-        {
-          name: tool_class.tool_name,
-          description: tool_class.desc,
-          inputSchema: tool_class.schema
-        }
-      end
-
-      render json: {result: tools}
-    end
-
-    def call_tool(params)
-      tool_name = params[:name]
-      arguments = JSON.parse(params[:arguments] || "{}")
-
-      unless tool_name
-        render json: {error: "Invalid params: missing tool name"}, status: 422
-        return
-      end
-
-      tool_class = Tool.registered_tools.find do |tc|
-        tc.tool_name == tool_name
-      end
-
-      unless tool_class
-        render json: {error: "Tool not found: #{tool_name}"}, status: 404
-        return
-      end
-      
-      # 認可チェック
-      unless tool_class.authorized?(@auth_info)
-        render json: {error: "Unauthorized: Access to tool '#{tool_name}' denied"}, status: 403
-        return
-      end
-
-      tool = tool_class.new
-      validation_result = tool.validate_arguments(arguments)
-
-      if validation_result.is_a?(Hash) && validation_result[:error]
-        render json: {result: validation_result[:error]}
-        return
-      end
-
-      begin
-        arguments[:auth_info] = @auth_info if @auth_info.present?
-
-        result = tool.call(**arguments.symbolize_keys)
-        render json: {result: result}
-      rescue => e
-        render json: {error: "Error: #{e.message}"}
-      end
-    end
   end
 end

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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,34 @@
+module ActiveMcp
+  module Response
+    class Initialize
+      def self.to_hash(id:, name:, version:)
+        {
+          body: {
+            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
+              }
+            }
+          },
+          status: 200
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module ActiveMcp
+  module Response
+    class Initialized
+      def self.to_hash
+        {
+          body: {
+            jsonrpc: JSON_RPC_VERSION,
+            method: Method::INITIALIZED
+          },
+          status: 200
+        }
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,66 @@
+module ActiveMcp
+  module Response
+    module ToolsCall
+      class Json
+        def self.call(params:, auth_info:)
+          tool_name = params[:name]
+
+          unless tool_name
+            return {
+              body: {error: "Invalid params: missing tool name"},
+              status: 400
+            }
+          end
+
+          tool_class = Tool.registered_tools.find do |tc|
+            tc.tool_name == tool_name
+          end
+
+          unless tool_class
+            return {
+              body: {error: "Tool not found: #{tool_name}"},
+              status: 404
+            }
+          end
+
+          unless tool_class.authorized?(auth_info)
+            return {
+              body: {error: "Unauthorized: Access to tool '#{tool_name}' denied"},
+              status: 401
+            }
+          end
+
+          arguments = params[:arguments].permit!.to_hash.symbolize_keys.transform_values { _1.match(/^\d+$/) ? _1.to_i : _1 }
+
+          p arguments
+
+          tool = tool_class.new
+          validation_result = tool.validate_arguments(arguments)
+
+          if validation_result.is_a?(Hash) && validation_result[:error]
+            return {
+              body: {result: validation_result[:error]},
+              status: 400
+            }
+          end
+
+          begin
+            arguments[:auth_info] = auth_info if auth_info.present?
+
+            result = tool.call(**arguments.symbolize_keys)
+
+            return {
+              body: {result: result},
+              status: 200,
+            }
+          rescue => e
+            return {
+              body: {error: "Error: #{e.message}"},
+              status: 500
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module ActiveMcp
+  module Response
+    module ToolsCall
+      class Jsonrpc
+        def self.call(id:, params:, auth_info:)
+          result = Json.call(params: params[:params], auth_info:)
+          {
+            body: {
+              jsonrpc: JSON_RPC_VERSION,
+              id:,
+              result: {
+                content: [
+                  {
+                    type: "text",
+                    text: result[:body][:result]
+                  }
+                ]
+              },
+            },
+            status: result[:status]
+          }
+        end
+      end
+    end
+  end
+end

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

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

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

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

data/lib/active_mcp/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveMcp
+  class Configuration
+    attr_accessor :server_name, :server_version
+
+    def initialize
+      @server_name = "MCP Server"
+      @server_version = "1.0.0"
+    end
+  end
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/active_mcp/server/methods.rb

@@ -4,6 +4,7 @@ module ActiveMcp
   module Method
     INITIALIZE = "initialize"
     INITIALIZED = "notifications/initialized"
+    CANCELLED = "notifications/cancelled"
     PING = "ping"
     TOOLS_LIST = "tools/list"
     TOOLS_CALL = "tools/call"

data/lib/active_mcp/server/protocol_handler.rb

@@ -173,7 +173,7 @@ module ActiveMcp
         if defined?(Rails)
           Rails.logger.error(error_details)
         else
-          # Fallback to standard error output if Rails is not available
+          # Fresallback to standard error output if Rails is not available
           $stderr.puts(error_details)
         end
       end

data/lib/active_mcp/server/tool_manager.rb

@@ -76,7 +76,7 @@ module ActiveMcp
         request.body = JSON.generate({
           method: "tools/call",
           name:,
-          arguments: arguments.to_json
+          arguments: arguments
         })
         request["Content-Type"] = "application/json"
         request["Authorization"] = @auth_header

data/lib/active_mcp/version.rb

@@ -1,3 +1,3 @@
 module ActiveMcp
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/lib/active_mcp.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "active_mcp/version"
+require_relative "active_mcp/configuration"
 require_relative "active_mcp/tool"
 require_relative "active_mcp/server"
 

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

@@ -0,0 +1,17 @@
+module ActiveMcp
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      
+      desc "Creates an Active MCP initializer and mounts the engine in your routes"
+      
+      def create_initializer_file
+        template "initializer.rb", "config/initializers/active_mcp.rb"
+      end
+      
+      def update_routes
+        route "mount ActiveMcp::Engine, at: '/mcp'"
+      end
+    end
+  end
+end

data/lib/generators/active_mcp/install/templates/initializer.rb

@@ -0,0 +1,5 @@
+# Active MCP configuration
+ActiveMcp.configure do |config|
+  config.server_name = 'MCP Server'
+  config.server_version = '1.0.0'
+end

data/lib/generators/active_mcp/install/templates/mcp_server.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# MCP Server script for Active MCP
+require 'active_mcp'
+
+# Load Rails application
+ENV['RAILS_ENV'] ||= 'development'
+require File.expand_path('../config/environment', __dir__)
+
+# Initialize MCP server
+server = ActiveMcp::Server.new(
+  name: "<%= Rails.application.class.module_parent_name %> MCP Server",
+  uri: '<%= Rails.application.config.action_controller.default_url_options&.fetch(:host, 'http://localhost:3000') %>/mcp'
+)
+
+# Optional authentication
+<% if ActiveMcp.config.auth_enabled %>
+server.auth = {
+  type: :bearer,
+  token: ENV['MCP_AUTH_TOKEN'] || '<%= ActiveMcp.config.auth_token %>'
+}
+<% end %>
+
+# Start the server
+puts "Starting MCP server for <%= Rails.application.class.module_parent_name %>..."
+puts "Connect to this server in MCP clients using the following configuration:"
+puts
+puts "   Command: #{File.expand_path(__FILE__)}"
+puts "   Args: []"
+puts
+puts "Press Ctrl+C to stop the server"
+server.start

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_mcp
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Your Name
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2025-04-04 00:00:00.000000000 Z
+date: 2025-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -54,8 +54,18 @@ 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
 - config/routes.rb
 - lib/active_mcp.rb
+- lib/active_mcp/configuration.rb
 - lib/active_mcp/engine.rb
 - lib/active_mcp/server.rb
 - lib/active_mcp/server/error_codes.rb
@@ -65,6 +75,9 @@ files:
 - lib/active_mcp/server/tool_manager.rb
 - lib/active_mcp/tool.rb
 - lib/active_mcp/version.rb
+- lib/generators/active_mcp/install/install_generator.rb
+- lib/generators/active_mcp/install/templates/initializer.rb
+- lib/generators/active_mcp/install/templates/mcp_server.rb
 - lib/generators/active_mcp/tool/templates/tool.rb.erb
 - lib/generators/active_mcp/tool/tool_generator.rb
 homepage: https://github.com/moekiorg/active_mcp