active_mcp 0.10.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49d9a9ba2c33ca5348dffb9f75eb76ea6bb9b45f2a16b89c9426ee16749932e2
-  data.tar.gz: b15302452096771d1faf85f06ab4c912a5f008bbc4671a7f083685b96e4b7eaf
+  metadata.gz: dfbed9e2449de9de95e9c207351c157ebb8c4bf3c3e8483ca3c2083f4222d003
+  data.tar.gz: a29ac4be0a08aff010bead8ad35f46047ce698da651a709754b0ae8ec50f447c
 SHA512:
-  metadata.gz: 9e486f88ea969a7433a7b43260455350e03c66ec886c831556f0231d62e1c68ef5d26aa099a0c4a8c6209fdf7b5d91f152718b4f6d2a1b770fc79fd7bbca6567
-  data.tar.gz: 2302c7cf9cb07751cc88d8dea155f14858e82f32a7f875904cd6bbc449f0ca7b3f6d7c8d3c172c418e3dfa90a661f9dfd88e508dce3398a2e69baa03d132c0cb
+  metadata.gz: 9bcf5ed73689ac7ce9e6a83b375a5cbfb02f4b20d6c4eb0a653f27675f2bae4c12b3f37e05b62379ebf3b924fb14677f418577e4fe09c0c669ea057a36fad244
+  data.tar.gz: 05afff2d249672089f785232d26a9c0bc0235d600bdf4a807f4dac9bda66f52437f7f625b619f3ebf649876143525e24559b8db248ed7c51b796600f6f47036d

data/README.md

@@ -38,7 +38,6 @@ A Ruby on Rails engine for the [Model Context Protocol (MCP)](https://modelconte
     - [Creating Resource Templates](#creating-resource-templates)
   - [💬 MCP Prompts](#-mcp-prompts)
     - [Creating Prompt](#creating-prompt)
-  - [📥 Using Context in the Schema](#-using-context-in-the-schema)
   - [💡 Best Practices](#-best-practices)
     - [1. Create Specific Tool Classes](#1-create-specific-tool-classes)
     - [2. Validate and Sanitize Inputs](#2-validate-and-sanitize-inputs)
@@ -95,13 +94,9 @@ $ rails generate active_mcp:tool create_note
 
 ```ruby
 class CreateNoteTool < ActiveMcp::Tool::Base
-  def tool_name
-    "create_note"
-  end
+  tool_name "create_note"
 
-  def description
-    "Create Note"
-  end
+  description "Create Note"
 
   argument :title, :string, required: true
   argument :content, :string, required: true
@@ -118,11 +113,7 @@ end
 
 ```ruby
 class MySchema < ActiveMcp::Schema::Base
-  def tools
-    [
-      CreateNoteTool.new
-    ]
-  end
+  tools CreateNoteTool
 end
 ```
 
@@ -223,13 +214,9 @@ MCP tools are Ruby classes that inherit from `ActiveMcp::Tool::Base` and define
 
 ```ruby
 class SearchUsersTool < ActiveMcp::Tool::Base
-  def tool_name
-    "Search Users"
-  end
+  tool_name "Search Users"
 
-  def description
-    'Search users by criteria'
-  end
+  description 'Search users by criteria'
 
   argument :email, :string, required: false, description: 'Email to search for'
   argument :name, :string, required: false, description: 'Name to search for'
@@ -278,18 +265,14 @@ Control access to tools by overriding the `visible?` class method:
 
 ```ruby
 class AdminOnlyTool < ActiveMcp::Tool::Base
-  def tool_name
-    "admin_only_tool"
-  end
+  tool_name "admin_only_tool"
 
-  def description
-    "Admin-only tool"
-  end
+  description "Admin-only tool"
 
   argument :command, :string, required: true, description: "Admin command"
 
   # Only allow admins to access this tool
-  def visible?(context:)
+  def self.visible?(context:)
     return false unless context
     return false unless context[:auth_info][:type] == :bearer
 
@@ -350,11 +333,7 @@ Resources are Ruby classes `**Resource`:
 
 ```ruby
 class UserResource < ActiveMcp::Resource::Base
-  class << self
-    def mime_type
-      "application/json"
-    end
-  end
+  mime_type "application/json"
 
   def initialize(id:)
     @user = User.find(id)
@@ -372,7 +351,7 @@ class UserResource < ActiveMcp::Resource::Base
     @user.profile
   end
 
-  def visible?(context:)
+  def self.visible?(context:)
     # Your logic...
   end
 
@@ -390,10 +369,8 @@ end
 
 ```ruby
 class MySchema < ActiveMcp::Schema::Base
-  def resources
-    User.all.each do |user|
-      UserResource.new(id: user.id)
-    end
+  resource UserResource, items: User.all.each do |user|
+    { id: user.id }
   end
 end
 ```
@@ -415,11 +392,7 @@ end
 
 ```ruby
 class ImageResource < ActiveMcp::Resource::Base
-  class << self
-    def mime_type
-      "image/png"
-    end
-  end
+  mime_type "image/png"
 
   def resource_name
     "profile_image"
@@ -462,32 +435,22 @@ Resource teamplates are Ruby classes `**Resource`:
 
 ```ruby
 class UserResource < ActiveMcp::Resource::Base
-  class << self
-    def resource_template_name
-      "users"
-    end
-
-    def uri_template
-      "data://localhost/users/{id}"
-    end
-
-    def mime_type
-      "application/json"
-    end
-
-    def description
-      "This is a test."
-    end
-
-    def visible?(context:)
-      # Your logic...
-    end
-  end
+  resource_template_name "users"
+
+  uri_template "data://localhost/users/{id}"
+
+  mime_type "application/json"
+
+  description "This is a test."
 
   argument :id, complete: ->(value, context) do
     User.all.pluck(:id).filter { _1.match(value) }
   end
 
+  def self.visible?(context:)
+    # Your logic...
+  end
+
   def initialize(id:)
     @user = User.find(id)
   end
@@ -512,10 +475,8 @@ end
 
 ```ruby
 class MySchema < ActiveMcp::Schema::Base
-  def resources
-    User.all.each do |user|
-      UserResource.new(id: user.id)
-    end
+  resource UserResource, items: User.all.each do |user|
+    { id: user.id }
   end
 end
 ```
@@ -530,23 +491,15 @@ Resources are Ruby classes `**Prompt`:
 
 ```ruby
 class HelloPrompt < ActiveMcp::Prompt::Base
-  argument :name, required: true, description: "User name", complete: ->(value, context) do
-    User.all.pluck(:name).filter { _1.match(value) }
-  end
-
-  def initialize(greeting:)
-    @greeting = greeting
-  end
+  prompt_name "hello"
 
-  def prompt_name
-    "hello"
-  end
+  description "This is a test."
 
-  def description
-    "This is a test."
+  argument :name, required: true, description: "User name", complete: ->(value, context) do
+    User.all.pluck(:name).filter { _1.match(value) }
   end
 
-  def visible?(context:)
+  def self.visible?(context:)
     # Your logic...
   end
 
@@ -554,7 +507,7 @@ class HelloPrompt < ActiveMcp::Prompt::Base
     [
       ActiveMcp::Message::Text.new(
         role: "user",
-        text: "#{@greeting} #{name}"
+        text: "Hello! #{name}"
       ),
       ActiveMcp::Message::Image.new(
         role: "assistant",
@@ -577,41 +530,7 @@ end
 
 ```ruby
 class MySchema < ActiveMcp::Schema::Base
-  def prompts
-    [
-      HelloPrompt.new(greeting: "Hello!")
-    ]
-  end
-end
-```
-
-## 📥 Using Context in the Schema
-
-```ruby
-class MySchema < ActiveMcp::Schema::Base
-  def prompts
-    user = User.find_by_token(context[:auth_info][:token])
-
-    user.greetings.map do |greeting|
-      GreetingPrompt.new(greeting: greeting)
-    end
-  end
-end
-```
-
-```ruby
-class GreetingPrompt < ActiveMcp::Prompt::Base
-  def initialize(greeting:)
-    @greeting = greeting
-  end
-
-  def prompt_name
-    "greeting_#{@greeting.text}"
-  end
-
-  def messages
-    # ...
-  end
+  prompt HelloPrompt
 end
 ```
 

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

@@ -50,7 +50,7 @@ module ActiveMcp
         @format = :jsonrpc
         render "active_mcp/prompts_list", formats: :json
       when Method::PROMPTS_GET
-        @prompt = schema.visible_prompts.find { _1.prompt_name == params[:params][:name] }
+        @prompt = schema.visible_prompts.find { _1.prompt_name_value == params[:params][:name] }
         @format = :jsonrpc
         render "active_mcp/prompts_get", formats: :json
       else
@@ -91,7 +91,7 @@ module ActiveMcp
         @format = :json
         render "active_mcp/prompts_list", formats: :json
       when Method::PROMPTS_GET
-        @prompt = schema.visible_prompts&.find { _1.prompt_name == params[:params][:name] }
+        @prompt = schema.visible_prompts&.find { _1.prompt_name_value == params[:params][:name] }
         @format = :json
         render "active_mcp/prompts_get", formats: :json
       else

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

@@ -25,7 +25,7 @@ module ActiveMcp
         }
       end
 
-      if resource.respond_to?(:visible?) && !resource.visible?(context:)
+      if resource.class.respond_to?(:visible?) && !resource.class.visible?(context:)
         return {
           isError: true,
           contents: []
@@ -38,7 +38,7 @@ module ActiveMcp
             contents: [
               {
                 uri:,
-                mimeType: resource.class.mime_type,
+                mimeType: resource.class.mime_type_value,
                 text: content
               }
             ]
@@ -48,7 +48,7 @@ module ActiveMcp
             contents: [
               {
                 uri:,
-                mimeType: resource.class.mime_type,
+                mimeType: resource.class.mime_type_value,
                 blob: Base64.strict_encode64(content)
               }
             ]

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

@@ -20,11 +20,11 @@ module ActiveMcp
         }
       end
 
-      tool = schema.visible_tools.find do |tc|
-        tc.tool_name == tool_name
+      tool_class = schema.visible_tools&.find do |tc|
+        tc.tool_name_value == tool_name
       end
 
-      unless tool
+      unless tool_class
         return {
           isError: true,
           content: [
@@ -36,7 +36,7 @@ module ActiveMcp
         }
       end
 
-      unless tool.visible?(context:)
+      unless tool_class.visible?(context:)
         return {
           isError: true,
           content: [
@@ -64,7 +64,9 @@ module ActiveMcp
         end
       end
 
-      validation_result = tool.validate_arguments(arguments)
+      tool = tool_class.new
+
+      validation_result = tool.validate(arguments)
 
       if validation_result.is_a?(Hash) && validation_result[:error]
         return {

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

@@ -2,6 +2,6 @@ json.jsonrpc ActiveMcp::JSON_RPC_VERSION if @format == :jsonrpc
 json.id @id if @format == :jsonrpc && @id.present?
 
 json.result do
-  json.description @prompt.description
-  json.messages @prompt.messages(**params[:params][:arguments].permit!.to_h.symbolize_keys).map(&:to_h)
+  json.description @prompt.description_value
+  json.messages @prompt.new.messages(**params[:params][:arguments].permit!.to_h.symbolize_keys).map(&:to_h)
 end

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

@@ -4,9 +4,9 @@ json.id @id if @format == :jsonrpc && @id.present?
 json.result do
   json.prompts do
     json.array!(@prompts) do |prompt|
-      json.name prompt.prompt_name
-      json.description prompt.description
-      json.arguments prompt.class.arguments ? prompt.class.arguments.map { _1.except(:complete) } : []
+      json.name prompt.prompt_name_value
+      json.description prompt.description_value
+      json.arguments prompt.arguments ? prompt.arguments.map { _1.except(:complete) } : []
     end
   end
 end

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

@@ -3,11 +3,11 @@ json.id @id if @format == :jsonrpc && @id.present?
 
 json.result do
   json.resourceTemplates do
-    json.array!(@resource_templates) do |resource|
-      json.name resource.resource_template_name
-      json.uriTemplate resource.uri_template
-      json.mimeType resource.mime_type
-      json.description resource.description
+    json.array!(@resource_templates) do |template|
+      json.name template.resource_template_name_value
+      json.uriTemplate template.uri_template_value
+      json.mimeType template.mime_type_value
+      json.description template.description_value
     end
   end
 end

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

@@ -6,7 +6,7 @@ json.result do
     json.array!(@resources) do |resource|
       json.name resource.resource_name
       json.uri resource.uri
-      json.mimeType resource.class.mime_type
+      json.mimeType resource.class.mime_type_value
       json.description resource.description
     end
   end

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

@@ -4,9 +4,9 @@ json.id @id if @format == :jsonrpc && @id.present?
 json.result do
   json.tools do
     json.array!(@tools) do |tool|
-      json.name tool.tool_name
-      json.description tool.description
-      json.inputSchema tool.class.schema
+      json.name tool.tool_name_value
+      json.description tool.description_value
+      json.inputSchema tool.schema
     end
   end
 end

data/lib/active_mcp/completion.rb

@@ -7,7 +7,7 @@ module ActiveMcp
       value = params.dig(:argument, :value)
 
       if uri_template
-        resource_class = refs.find { _1.uri_template == uri_template }
+        resource_class = refs.find { _1.uri_template_value == uri_template }
         values = resource_class.arguments[arg_name.to_sym].call(value, context)
         {values:, total: values.length}
       elsif ref_name

data/lib/active_mcp/message/resource.rb

@@ -13,7 +13,7 @@ module ActiveMcp
             type: "resource",
             resource: {
               uri: @resource.uri,
-              mimeType: @resource.class.mime_type,
+              mimeType: @resource.class.mime_type_value,
               text: @resource.content
             }
           }

data/lib/active_mcp/prompt/base.rb

@@ -2,7 +2,15 @@ module ActiveMcp
   module Prompt
     class Base
       class << self
-        attr_reader :arguments
+        attr_reader :prompt_name_value, :description_value, :arguments
+
+        def prompt_name(value)
+          @prompt_name_value = value
+        end
+
+        def description(value)
+          @description_value = value
+        end
 
         def argument(name, required: false, description: "", complete: -> {})
           @arguments ||= []
@@ -19,12 +27,6 @@ module ActiveMcp
       def initialize(*args, context: {})
       end
 
-      def prompt_name
-      end
-
-      def description
-      end
-
       def visible?(context: {})
         true
       end

data/lib/active_mcp/resource/base.rb

@@ -4,12 +4,22 @@ module ActiveMcp
   module Resource
     class Base
       class << self
-        attr_reader :schema, :arguments
+        attr_reader :resource_template_name_value, :description_value, :mime_type_value, :uri_template_value, :schema, :arguments
 
-        def description
+        def resource_template_name(value)
+          @resource_template_name_value = value
         end
 
-        def mime_type
+        def uri_template(value)
+          @uri_template_value = value
+        end
+
+        def description(value)
+          @description_value = value
+        end
+
+        def mime_type(value)
+          @mime_type_value = value
         end
 
         def argument(name, complete:)

data/lib/active_mcp/schema/base.rb

@@ -1,46 +1,55 @@
 module ActiveMcp
   module Schema
     class Base
-      attr_reader :context
+      class << self
+        attr_reader :tools, :resources, :prompts
 
-      def initialize(context: {})
-        @context = context
-      end
+        def tool(value)
+          @tools ||= []
+          @tools << value
+        end
 
-      def tools
-        []
-      end
+        def resource(value, items: [])
+          @resources ||= []
+          @resources << {klass: value, items:}
+        end
 
-      def resources
-        []
+        def prompt(value)
+          @prompts ||= []
+          @prompts << value
+        end
       end
 
-      def prompts
-        []
+      def initialize(context: {})
+        @context = context
       end
 
       def visible_resources
-        resources&.filter do |resource|
-          !resource.respond_to?(:visible?) || resource.visible?(context: @context)
+        visibles = self.class.resources&.filter do |resource|
+          !resource[:klass].respond_to?(:visible?) || resource[:klass].visible?(context: @context)
         end
+        visibles&.map do |resource|
+          resource[:items].map do |item|
+            resource[:klass].new(**item)
+          end
+        end&.flatten || []
       end
 
       def visible_resource_templates
-        resource_instances = resources&.filter do |resource|
-          resource.class.respond_to?(:uri_template) && (!resource.respond_to?(:visible?) || resource.visible?(context: @context))
+        visibles = self.class.resources&.filter do |resource|
+          resource[:klass].respond_to?(:uri_template) && (!resource[:klass].respond_to?(:visible?) || resource[:klass].visible?(context: @context))
         end
-
-        resource_instances.map(&:class).uniq
+        visibles&.map { _1[:klass] } || []
       end
 
       def visible_tools
-        tools&.filter do |tool|
+        self.class.tools&.filter do |tool|
           !tool.respond_to?(:visible?) || tool.visible?(context: @context)
         end
       end
 
       def visible_prompts
-        prompts&.filter do |resource|
+        self.class.prompts&.filter do |resource|
           !resource.respond_to?(:visible?) || resource.visible?(context: @context)
         end
       end

data/lib/active_mcp/server.rb

@@ -38,7 +38,7 @@ module ActiveMcp
     attr_reader :name, :version, :uri, :protocol_handler, :fetcher
 
     def initialize(
-      version: ActiveMcp::VERSION,
+      version: "1.0.0",
       name: "ActiveMcp",
       uri: nil,
       auth: nil

data/lib/active_mcp/tool/base.rb

@@ -4,7 +4,15 @@ module ActiveMcp
   module Tool
     class Base
       class << self
-        attr_reader :schema
+        attr_reader :tool_name_value, :description_value, :schema
+
+        def tool_name(value)
+          @tool_name_value = value
+        end
+
+        def description(value)
+          @description_value = value
+        end
 
         def argument(name, type, required: false, description: "")
           @schema ||= default_schema
@@ -21,32 +29,26 @@ module ActiveMcp
             "required" => []
           }
         end
-      end
-
-      def initialize
-      end
-
-      def tool_name
-      end
 
-      def description
-      end
-
-      def visible?(context: {})
-        true
+        def visible?(context: {})
+          true
+        end
       end
 
-      def call(context: {}, **args)
-        raise NotImplementedError, "#{self.class.name}#call must be implemented"
+      def initialize
       end
 
-      def validate_arguments(args)
+      def validate(args)
         return true unless self.class.schema
 
         JSON::Validator.validate!(self.class.schema, args)
       rescue JSON::Schema::ValidationError => e
         {error: e.message}
       end
+
+      def call(context: {}, **args)
+        raise NotImplementedError, "#{self.class.name}#call must be implemented"
+      end
     end
   end
 end

data/lib/active_mcp/version.rb

@@ -1,3 +1,3 @@
 module ActiveMcp
-  VERSION = "0.10.8"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_mcp
 version: !ruby/object:Gem::Version
-  version: 0.10.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Moeki Kawakami