actionmcp 0.53.0 → 0.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 961fd09ccf447057085e6e63d38c64079b460917d48d70c5ad5dc53ee0c3154f
-  data.tar.gz: c74e249d91903199a65afa5ecad8ff55bf188aa7e48167742c26aa20396913cf
+  metadata.gz: 8f3d6323b7f8ce694050a031c566f30e33d637116e2869cda61fbbaad0702411
+  data.tar.gz: ef8bfccea1b3109146b3e490340a44c4a6071e08c6aed3bd72ddecd5fd95638a
 SHA512:
-  metadata.gz: 0f3637e231ef5d5f668d548c41a3d71c121946b4002d56faf27b6fe1941e8f5fb2cf3ed70b0bb49a370055124777ef7300bf3bec174cfa2802c321bbd56f95b2
-  data.tar.gz: d1066a9642357aa64e77e0bcbdfb99205dbbbe27140262d41aa0bc61aad900e007d6da5a0a136ed116e101fba365066184bb16602cff3caed3c755ddfca8d9bc
+  metadata.gz: 2665d85224ce5b07a115936d1f1d159b70c8068a8a221e2f196bebd9564b9e753a73acd15b86241b04d277e70dc6dc5db818fecda505cfab9beb999d8483aecb
+  data.tar.gz: 56a568c5aca9693534a46d1013a9fdd8cb168a92e10b6c947dc02bb345f0c0a4f5b812edac990ddaa84c0ba589c500d47b7841f22b8542b1f36a120d2c8a1756

data/README.md

@@ -476,16 +476,21 @@ This ensures all thread pools are properly terminated and tasks are completed.
 
 **ActionMCP** runs as a standalone Rack application. **Do not attempt to mount it in your application's `routes.rb`**—it is not designed to be mounted as an engine at a custom path. When you use `run ActionMCP::Engine` in your `mcp.ru`, the MCP endpoint is always available at the root path (`/`).
 
-### Installing the Configuration Generator
+### Installing ActionMCP
 
-ActionMCP includes a generator to help you create the configuration file:
+ActionMCP includes generators to help you set up your project quickly. The install generator creates all necessary base classes and configuration files:
 
 ```bash
-# Generate the mcp.yml configuration file
-bin/rails generate action_mcp:config
+# Install ActionMCP with base classes and configuration
+bin/rails generate action_mcp:install
 ```
 
-This will create `config/mcp.yml` with example configurations for all environments.
+This will create:
+- `app/mcp/prompts/application_mcp_prompt.rb` - Base prompt class
+- `app/mcp/tools/application_mcp_tool.rb` - Base tool class  
+- `app/mcp/resource_templates/application_mcp_res_template.rb` - Base resource template class
+- `app/mcp/application_gateway.rb` - Gateway for authentication
+- `config/mcp.yml` - Configuration file with example settings for all environments
 
 > **Note:** Authentication and authorization are not included. You are responsible for securing the endpoint.
 
@@ -647,14 +652,14 @@ location /mcp/ {
 
 ActionMCP includes Rails generators to help you quickly set up your MCP server components.
 
-You can generate the base classes for your MCP Prompt and Tool using the following command:
+First, install ActionMCP to create base classes and configuration:
 
 ```bash
 bin/rails action_mcp:install:migrations  # to copy the migrations
 bin/rails generate action_mcp:install 
 ```
 
-This will create the base application classes in your app directory.
+This will create the base application classes, configuration file, and authentication gateway in your app directory.
 
 ### Generate a New Prompt
 

data/app/models/action_mcp/session/message.rb

@@ -4,17 +4,17 @@
 #
 # Table name: action_mcp_session_messages
 #
-#  id                                     :bigint           not null, primary key
-#  direction(The message recipient)       :string           default("client"), not null
-#  is_ping(Whether the message is a ping) :boolean          default(FALSE), not null
-#  message_json                           :jsonb
-#  message_type(The type of the message)  :string           not null
-#  request_acknowledged                   :boolean          default(FALSE), not null
-#  request_cancelled                      :boolean          default(FALSE), not null
-#  created_at                             :datetime         not null
-#  updated_at                             :datetime         not null
-#  jsonrpc_id                             :string
-#  session_id                             :string           not null
+#  id                   :bigint           not null, primary key
+#  direction            :string           default("client"), not null
+#  is_ping              :boolean          default(FALSE), not null
+#  message_json         :json
+#  message_type         :string           not null
+#  request_acknowledged :boolean          default(FALSE), not null
+#  request_cancelled    :boolean          default(FALSE), not null
+#  created_at           :datetime         not null
+#  updated_at           :datetime         not null
+#  jsonrpc_id           :string
+#  session_id           :string           not null
 #
 # Indexes
 #
@@ -22,7 +22,7 @@
 #
 # Foreign Keys
 #
-#  fk_action_mcp_session_messages_session_id  (session_id => action_mcp_sessions.id) ON DELETE => cascade ON UPDATE => cascade
+#  fk_rails_...  (session_id => action_mcp_sessions.id) ON DELETE => cascade ON UPDATE => cascade
 #
 module ActionMCP
   class Session

data/app/models/action_mcp/session.rb

@@ -4,28 +4,28 @@
 #
 # Table name: action_mcp_sessions
 #
-#  id                                                  :string           not null, primary key
-#  authentication_method                               :string           default("none")
-#  client_capabilities(The capabilities of the client) :jsonb
-#  client_info(The information about the client)       :jsonb
-#  ended_at(The time the session ended)                :datetime
-#  initialized                                         :boolean          default(FALSE), not null
-#  messages_count                                      :integer          default(0), not null
-#  oauth_access_token                                  :string
-#  oauth_refresh_token                                 :string
-#  oauth_token_expires_at                              :datetime
-#  oauth_user_context                                  :jsonb
-#  prompt_registry                                     :jsonb
-#  protocol_version                                    :string
-#  resource_registry                                   :jsonb
-#  role(The role of the session)                       :string           default("server"), not null
-#  server_capabilities(The capabilities of the server) :jsonb
-#  server_info(The information about the server)       :jsonb
-#  sse_event_counter                                   :integer          default(0), not null
-#  status                                              :string           default("pre_initialize"), not null
-#  tool_registry                                       :jsonb
-#  created_at                                          :datetime         not null
-#  updated_at                                          :datetime         not null
+#  id                     :string           not null, primary key
+#  authentication_method  :string           default("none")
+#  client_capabilities    :json
+#  client_info            :json
+#  ended_at               :datetime
+#  initialized            :boolean          default(FALSE), not null
+#  messages_count         :integer          default(0), not null
+#  oauth_access_token     :string
+#  oauth_refresh_token    :string
+#  oauth_token_expires_at :datetime
+#  oauth_user_context     :json
+#  prompt_registry        :json
+#  protocol_version       :string
+#  resource_registry      :json
+#  role                   :string           default("server"), not null
+#  server_capabilities    :json
+#  server_info            :json
+#  sse_event_counter      :integer          default(0), not null
+#  status                 :string           default("pre_initialize"), not null
+#  tool_registry          :json
+#  created_at             :datetime         not null
+#  updated_at             :datetime         not null
 #
 # Indexes
 #

data/db/migrate/20250512154359_consolidated_migration.rb

@@ -11,16 +11,16 @@ class ConsolidatedMigration < ActiveRecord::Migration[8.0]
         t.string :status, null: false, default: 'pre_initialize'
         t.datetime :ended_at, comment: 'The time the session ended'
         t.string :protocol_version
-        t.jsonb :server_capabilities, comment: 'The capabilities of the server'
-        t.jsonb :client_capabilities, comment: 'The capabilities of the client'
-        t.jsonb :server_info, comment: 'The information about the server'
-        t.jsonb :client_info, comment: 'The information about the client'
+        t.json :server_capabilities, comment: 'The capabilities of the server'
+        t.json :client_capabilities, comment: 'The capabilities of the client'
+        t.json :server_info, comment: 'The information about the server'
+        t.json :client_info, comment: 'The information about the client'
         t.boolean :initialized, null: false, default: false
         t.integer :messages_count, null: false, default: 0
         t.integer :sse_event_counter, default: 0, null: false
-        t.jsonb :tool_registry, default: []
-        t.jsonb :prompt_registry, default: []
-        t.jsonb :resource_registry, default: []
+        t.json :tool_registry, default: []
+        t.json :prompt_registry, default: []
+        t.json :resource_registry, default: []
         t.timestamps
       end
     end
@@ -36,7 +36,7 @@ class ConsolidatedMigration < ActiveRecord::Migration[8.0]
         t.string :direction, null: false, comment: 'The message recipient', default: 'client'
         t.string :message_type, null: false, comment: 'The type of the message'
         t.string :jsonrpc_id
-        t.jsonb :message_json
+        t.json :message_json
         t.boolean :is_ping, default: false, null: false, comment: 'Whether the message is a ping'
         t.boolean :request_acknowledged, default: false, null: false
         t.boolean :request_cancelled, null: false, default: false
@@ -98,15 +98,15 @@ class ConsolidatedMigration < ActiveRecord::Migration[8.0]
       end
 
       unless column_exists?(:action_mcp_sessions, :tool_registry)
-        add_column :action_mcp_sessions, :tool_registry, :jsonb, default: []
+        add_column :action_mcp_sessions, :tool_registry, :json, default: []
       end
 
       unless column_exists?(:action_mcp_sessions, :prompt_registry)
-        add_column :action_mcp_sessions, :prompt_registry, :jsonb, default: []
+        add_column :action_mcp_sessions, :prompt_registry, :json, default: []
       end
 
       unless column_exists?(:action_mcp_sessions, :resource_registry)
-        add_column :action_mcp_sessions, :resource_registry, :jsonb, default: []
+        add_column :action_mcp_sessions, :resource_registry, :json, default: []
       end
     end
 
@@ -132,7 +132,10 @@ class ConsolidatedMigration < ActiveRecord::Migration[8.0]
 
     return unless column_exists?(:action_mcp_session_messages, :direction)
 
-    change_column_comment :action_mcp_session_messages, :direction, 'The message recipient'
+    # SQLite3 doesn't support changing column comments
+    if connection.adapter_name.downcase != 'sqlite'
+      change_column_comment :action_mcp_session_messages, :direction, 'The message recipient'
+    end
   end
 
   private

data/db/migrate/20250608112101_add_oauth_to_sessions.rb

@@ -2,8 +2,8 @@
 
 class AddOAuthToSessions < ActiveRecord::Migration[8.0]
   def change
-    # Use jsonb for PostgreSQL, json for other databases (SQLite3, MySQL)
-    json_type = connection.adapter_name.downcase == 'postgresql' ? :jsonb : :json
+    # Use json for all databases (PostgreSQL, SQLite3, MySQL) for consistency
+    json_type = :json
 
     add_column :action_mcp_sessions, :oauth_access_token, :string
     add_column :action_mcp_sessions, :oauth_refresh_token, :string

data/lib/action_mcp/version.rb

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

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

@@ -7,6 +7,8 @@ module ActionMcp
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
+      desc "Install ActionMCP with base classes and configuration"
+
       def create_application_prompt_file
         template "application_mcp_prompt.rb", File.join("app/mcp/prompts", "application_mcp_prompt.rb")
       end
@@ -20,13 +22,42 @@ module ActionMcp
                  File.join("app/mcp/resource_templates", "application_mcp_res_template.rb")
       end
 
-      def create_mcp_profile_file
+      def create_mcp_configuration_file
         template "mcp.yml", File.join("config", "mcp.yml")
       end
 
       def create_application_gateway_file
         template "application_gateway.rb", File.join("app/mcp", "application_gateway.rb")
       end
+
+      def show_instructions
+        say ""
+        say "ActionMCP has been installed successfully!"
+        say ""
+        say "Files created:"
+        say "  - app/mcp/prompts/application_mcp_prompt.rb"
+        say "  - app/mcp/tools/application_mcp_tool.rb"
+        say "  - app/mcp/resource_templates/application_mcp_res_template.rb"
+        say "  - app/mcp/application_gateway.rb"
+        say "  - config/mcp.yml"
+        say ""
+        say "Configuration:"
+        say "  The mcp.yml file contains authentication, profiles, and adapter settings."
+        say "  You can customize authentication methods, OAuth settings, and PubSub adapters."
+        say ""
+        say "Available adapters:"
+        say "  - simple      : In-memory adapter for development"
+        say "  - test        : Test adapter for testing environments"
+        say "  - solid_cable : Database-backed adapter (requires solid_cable gem)"
+        say "  - redis       : Redis-backed adapter (requires redis gem)"
+        say ""
+        say "Next steps:"
+        say "  1. Generate your first tool: rails generate action_mcp:tool MyTool"
+        say "  2. Generate your first prompt: rails generate action_mcp:prompt MyPrompt"
+        say "  3. Generate your first resource template: rails generate action_mcp:resource_template MyResource"
+        say "  4. Start the MCP server: bundle exec rails s -c mcp.ru -p 62770"
+        say ""
+      end
     end
   end
 end

data/lib/generators/action_mcp/install/templates/mcp.yml

@@ -1,21 +1,98 @@
+# ActionMCP Configuration
+# This file contains configuration for the ActionMCP server including
+# authentication, profiles, and pub/sub system settings.
+
 shared:
-  primary:
-    tools:
-      - all
-    prompts:
-      - all
-    resources:
-      - all
-    options:
-      list_changed: false
-      resources_subscribe: false
+  # Authentication configuration - array of methods to try in order
+  authentication: ["none"]  # No authentication required by default
+  
+  # OAuth configuration (if using OAuth authentication)
+  # oauth:
+  #   provider: "demo_oauth_provider"
+  #   scopes_supported: ["mcp:tools", "mcp:resources", "mcp:prompts"]
+  #   enable_dynamic_registration: true
+  #   enable_token_revocation: true
+  #   pkce_required: true
+  #   issuer_url: <%= ENV.fetch("OAUTH_ISSUER_URL") { "https://yourapp.com" } %>
+  
+  # MCP capability profiles
+  profiles:
+    primary:
+      tools:
+        - all
+      prompts:
+        - all
+      resources:
+        - all
+      options:
+        list_changed: false
+        logging_enabled: true
+        resources_subscribe: false
+        
+    minimal:
+      tools: []
+      prompts: []
+      resources: []
+      options:
+        list_changed: false
+        logging_enabled: false
+        logging_level: :warn
+        resources_subscribe: false
+
+# Development environment
+development:
+  # Use simple pub/sub adapter for development
+  adapter: simple
+  # Thread pool configuration (optional)
+  # min_threads: 5     # Minimum number of threads in the pool
+  # max_threads: 10    # Maximum number of threads in the pool
+  # max_queue: 100     # Maximum number of tasks that can be queued
+
+# Test environment
+test:
+  # JWT authentication for testing environment
+  authentication: ["jwt"]
+  
+  # Test adapter for testing
+  adapter: test
+
+# Production environment
+production:
+  # Multiple authentication methods - try OAuth first, fallback to JWT
+  authentication: ["oauth", "jwt"]
+  
+  # OAuth configuration for production
+  oauth:
+    provider: "application_oauth_provider"  # Your custom provider class
+    scopes_supported: ["mcp:tools", "mcp:resources", "mcp:prompts"]
+    enable_dynamic_registration: true
+    enable_token_revocation: true
+    pkce_required: true
+    issuer_url: <%= ENV.fetch("OAUTH_ISSUER_URL") { "https://yourapp.com" } %>
+  
+  # Additional production profiles for external clients
+  profiles:
+    external_clients:
+      tools: ["WeatherForecastTool"]  # Limited tool access for external clients
+      prompts: []
+      resources: []
+  
+  # Choose one of the following adapters:
+  
+  # 1. Database-backed adapter (recommended)
+  adapter: solid_cable
+  polling_interval: 0.5.seconds
+  # connects_to: cable  # Optional: specify a different database connection
+  
+  # Thread pool configuration (optional)
+  min_threads: 10     # Minimum number of threads in the pool
+  max_threads: 20     # Maximum number of threads in the pool
+  max_queue: 500      # Maximum number of tasks that can be queued
 
-#  minimal:
-#    tools: []
-#    prompts: []
-#    resources: []
-#    options:
-#      list_changed: false
-#      logging_enabled: false
-#      logging_level: :warn
-#      resources_subscribe: false
+  # 2. Redis-backed adapter (alternative)
+  # adapter: redis
+  # url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  # channel_prefix: <%= Rails.application.class.module_parent_name.underscore %>_production
+  # min_threads: 10    # Minimum number of threads in the pool
+  # max_threads: 20    # Maximum number of threads in the pool
+  # max_queue: 500     # Maximum number of tasks that can be queued

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actionmcp
 version: !ruby/object:Gem::Version
-  version: 0.53.0
+  version: 0.54.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -312,8 +312,6 @@ files:
 - lib/action_mcp/uri_ambiguity_checker.rb
 - lib/action_mcp/version.rb
 - lib/actionmcp.rb
-- lib/generators/action_mcp/config/config_generator.rb
-- lib/generators/action_mcp/config/templates/mcp.yml
 - lib/generators/action_mcp/install/install_generator.rb
 - lib/generators/action_mcp/install/templates/application_gateway.rb
 - lib/generators/action_mcp/install/templates/application_mcp_prompt.rb

data/lib/generators/action_mcp/config/config_generator.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module ActionMCP
-  module Generators
-    class ConfigGenerator < Rails::Generators::Base
-      namespace "action_mcp:config"
-      source_root File.expand_path("templates", __dir__)
-
-      desc "Creates ActionMCP configuration file (config/mcp.yml)"
-
-      def create_mcp_yml
-        template "mcp.yml", "config/mcp.yml"
-      end
-
-      def show_instructions
-        say "ActionMCP configuration file created at config/mcp.yml"
-        say "You can customize your PubSub adapters and other settings in this file."
-        say ""
-        say "Available adapters:"
-        say "  - simple   : In-memory adapter for development"
-        say "  - test     : Test adapter"
-        say "  - solid_cable : Database-backed adapter (requires solid_cable gem)"
-        say "  - redis    : Redis-backed adapter (requires redis gem)"
-        say ""
-      end
-    end
-  end
-end

data/lib/generators/action_mcp/config/templates/mcp.yml

@@ -1,104 +0,0 @@
-# ActionMCP Configuration
-# This file contains configuration for the ActionMCP server including
-# authentication, profiles, and pub/sub system settings.
-
-development:
-  # Authentication configuration - array of methods to try in order
-  authentication: ["none"]  # No authentication required for development
-  
-  # OAuth configuration (if using OAuth authentication)
-  # oauth:
-  #   provider: "demo_oauth_provider"
-  #   scopes_supported: ["mcp:tools", "mcp:resources", "mcp:prompts"]
-  #   enable_dynamic_registration: true
-  #   enable_token_revocation: true
-  #   pkce_required: true
-  
-  # MCP capability profiles
-  profiles:
-    primary:
-      tools: ["all"]
-      prompts: ["all"] 
-      resources: ["all"]
-      options:
-        list_changed: false
-        logging_enabled: true
-        resources_subscribe: false
-        
-    minimal:
-      tools: []
-      prompts: []
-      resources: []
-      options:
-        list_changed: false
-        logging_enabled: false
-        logging_level: :warn
-        resources_subscribe: false
-
-  # Pub/sub adapter configuration
-  adapter: simple
-  # Thread pool configuration (optional)
-  # min_threads: 5     # Minimum number of threads in the pool
-  # max_threads: 10    # Maximum number of threads in the pool
-  # max_queue: 100     # Maximum number of tasks that can be queued
-
-test:
-  # JWT authentication for testing
-  authentication: ["jwt"]
-  
-  profiles:
-    primary:
-      tools: ["all"]
-      prompts: ["all"]
-      resources: ["all"]
-      
-  # Test adapter for testing
-  adapter: test
-
-production:
-  # Multiple authentication methods - try OAuth first, fallback to JWT
-  authentication: ["oauth", "jwt"]
-  
-  # OAuth configuration for production
-  oauth:
-    provider: "application_oauth_provider"  # Your custom provider class
-    scopes_supported: ["mcp:tools", "mcp:resources", "mcp:prompts"]
-    enable_dynamic_registration: true
-    enable_token_revocation: true
-    pkce_required: true
-    # issuer_url: <%= ENV.fetch("OAUTH_ISSUER_URL") { "https://yourapp.com" } %>
-  
-  profiles:
-    primary:
-      tools: ["all"]
-      prompts: ["all"]
-      resources: ["all"]
-      options:
-        list_changed: false
-        logging_enabled: true
-        resources_subscribe: false
-        
-    external_clients:
-      tools: ["WeatherForecastTool"]  # Limited tool access for external clients
-      prompts: []
-      resources: []
-  
-  # Choose one of the following adapters:
-  
-  # 1. Database-backed adapter (recommended)
-  adapter: solid_cable
-  polling_interval: 0.5.seconds
-  # connects_to: cable  # Optional: specify a different database connection
-  
-  # Thread pool configuration (optional)
-  min_threads: 10     # Minimum number of threads in the pool
-  max_threads: 20     # Maximum number of threads in the pool
-  max_queue: 500      # Maximum number of tasks that can be queued
-
-  # 2. Redis-backed adapter (alternative)
-  # adapter: redis
-  # url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
-  # channel_prefix: <%= Rails.application.class.module_parent_name.underscore %>_production
-  # min_threads: 10    # Minimum number of threads in the pool
-  # max_threads: 20    # Maximum number of threads in the pool
-  # max_queue: 500     # Maximum number of tasks that can be queued