active_mcp 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 664064f2b6638585937706546194313e1b9beddcec7952bde94b34b39e39f851
-  data.tar.gz: d97d6e74d9a1235fa99f7362e0c38102069705b7c6ccb8f45d292ed6f45f08f3
+  metadata.gz: de9c4899c65706f1fb1281e3ac52c7eb5399e4ac6e0224dce35e0ef532779df7
+  data.tar.gz: ad0abe6c7af1b985260fbea629302fa5bcb69f1ac1c94455ccb187e771664691
 SHA512:
-  metadata.gz: bd746883f2345681dafaf3ba99d1925c11eb8bf0a2ee2dc25fd17d4f1c3906b371f961a64298edc998cc58b6c1424a55efdfbbd0195c5e6e7a21dd160376821d
-  data.tar.gz: dd3ccaa91bd1f807d6f2ea7fc9dc03dc363b30b4bcad3335448f34d978c70f98d63b0ac4641455e9600639d2b88c94ca6c47cd945c8a82edecc5577b4ecbe65c
+  metadata.gz: 8416f28a91cfbc836a78e05b5790b70e0236450f6d901f48df2070dae02095f5e8f436cb39f05dc2a4edd57240c5c8bba99e1a7a32b365c04cac6ec5ed32faaa
+  data.tar.gz: b3cacc88a0649c82959aaf7fa9b3f39fc0d9b9f3c2c1135ad82282667c92ecda8ce71ddc84d7133694a790fcb6a69caa3c45c48f7196662d4952e9c56d304aba

data/README.md

@@ -36,6 +36,8 @@ A Ruby on Rails engine for the [Model Context Protocol (MCP)](https://modelconte
     - [Resource Types](#resource-types)
   - [📦 MCP Resource Templates](#-mcp-resource-templates)
     - [Creating Resource Templates](#creating-resource-templates)
+  - [💬 MCP Prompts](#-mcp-prompts)
+    - [Creating Prompt](#creating-prompt)
   - [💡 Best Practices](#-best-practices)
     - [1. Create Specific Tool Classes](#1-create-specific-tool-classes)
     - [2. Validate and Sanitize Inputs](#2-validate-and-sanitize-inputs)
@@ -92,7 +94,7 @@ $ rails generate active_mcp:tool create_note
 
 ```ruby
 class CreateNoteTool < ActiveMcp::Tool::Base
-  def name
+  def tool_name
     "Create Note"
   end
 
@@ -122,7 +124,7 @@ end
 4. Create controller ans set up routing:
 
 ```ruby
-class MyMcpController < ActiveMcp::Controller::Base
+class MyMcpController < ActiveMcp::BaseController
   def schema
     MySchema.new(context:)
   end
@@ -213,7 +215,7 @@ MCP tools are Ruby classes that inherit from `ActiveMcp::Tool::Base` and define
 
 ```ruby
 class SearchUsersTool < ActiveMcp::Tool::Base
-  def name
+  def tool_name
     "Search Users"
   end
 
@@ -268,7 +270,7 @@ Control access to tools by overriding the `visible?` class method:
 
 ```ruby
 class AdminOnlyTool < ActiveMcp::Tool::Base
-  def name
+  def tool_name
     "Admin-only tool"
   end
 
@@ -345,7 +347,7 @@ class UserResource < ActiveMcp::Resource::Base
     @auth_info = auth_info
   end
 
-  def name
+  def resource_name
     @user.name
   end
 
@@ -408,7 +410,7 @@ class ImageResource < ActiveMcp::Resource::Base
     end
   end
 
-  def name
+  def resource_name
     "Profile Image"
   end
 
@@ -450,7 +452,7 @@ Resources are Ruby classes `**ResourceTemplates`:
 ```ruby
 class UserResource < ActiveMcp::Resource::Base
   class << self
-    def name
+    def resource_template_name
       "Users"
     end
 
@@ -479,7 +481,7 @@ class UserResource < ActiveMcp::Resource::Base
     @user = User.find(id)
   end
 
-  def name
+  def resource_name
     @user.name
   end
 
@@ -505,6 +507,69 @@ class MySchema < ActiveMcp::Schema::Base
 end
 ```
 
+## 💬 MCP Prompts
+
+MCP Prompts allow you to define prompt set.
+
+### Creating Prompt
+
+Resources are Ruby classes `**Prompt`:
+
+```ruby
+class HelloPrompt < ActiveMcp::Prompt::Base
+  class << self
+    def prompt_name
+      "hello"
+    end
+
+    def description
+      "This is a test."
+    end
+
+    def visible?(context:)
+      # Your logic...
+    end
+  end
+
+  argument :name, ->(value) do
+    User.all.pluck(:name).filter { _1.match(value) }
+  end
+
+  def initialize(name:)
+    @name = name
+  end
+
+  def messages
+    [
+      ActiveMcp::Message::Text.new(
+        role: "user",
+        text: "Hello! #{@name}"
+      ),
+      ActiveMcp::Message::Image.new(
+        role: "assistant",
+        data: File.read(file),
+        mime_type: "image/png"
+      ),
+      ActiveMcp::Message::Audio.new(
+        role: "user",
+        data: File.read(file),
+        mime_type: "audio/mpeg"
+      ),
+      ActiveMcp::Message::Resource.new(
+        role: "assistant",
+        resource: UserResource.new(name: @name)
+      )
+    ]
+  end
+end
+```
+
+```ruby
+class MySchema < ActiveMcp::Schema::Base
+  prompt HelloPrompt
+end
+```
+
 ## 💡 Best Practices
 
 ### 1. Create Specific Tool Classes

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

@@ -42,9 +42,17 @@ module ActiveMcp
         render 'active_mcp/tools_call', formats: :json
       when Method::COMPLETION_COMPLETE
         type = params.dig(:params, :ref, :type)
-        @completion = ActiveMcp::Completion.new.complete(params: params[:params], context:, refs: type === "ref/resource" ? schema.resource_templates : [])
+        @completion = ActiveMcp::Completion.new.complete(params: params[:params], context:, refs: type === "ref/resource" ? schema.resource_templates : schema.prompts)
         @format = :jsonrpc
         render "active_mcp/completion_complete", formats: :json
+      when Method::PROMPTS_LIST
+        @prompts = schema.prompts
+        @format = :jsonrpc
+        render 'active_mcp/prompts_list', formats: :json
+      when Method::PROMPTS_GET
+        @prompt = schema.prompts.find { _1.prompt_name == params[:params][:name] }.new(**params[:params][:arguments].permit!.to_h.symbolize_keys)
+        @format = :jsonrpc
+        render 'active_mcp/prompts_get', formats: :json
       else
         @format = :jsonrpc
         render 'active_mcp/no_method', formats: :json
@@ -75,9 +83,17 @@ module ActiveMcp
         render 'active_mcp/tools_call', formats: :json
       when Method::COMPLETION_COMPLETE
         type = params.dig(:params, :ref, :type)
-        @completion = ActiveMcp::Completion.new.complete(params: params[:params], context:, refs: type == "ref/resource" ? schema.resource_templates : [])
+        @completion = ActiveMcp::Completion.new.complete(params: params[:params], context:, refs: type == "ref/resource" ? schema.resource_templates : schema.prompts)
         @format = :json
         render "active_mcp/completion_complete", formats: :json
+      when Method::PROMPTS_LIST
+        @prompts = schema.prompts
+        @format = :json
+        render 'active_mcp/prompts_list', formats: :json
+      when Method::PROMPTS_GET
+        @prompt = schema.prompts&.find { _1.prompt_name == params[:params][:name] }.new(**params[:params][:arguments].permit!.to_h.symbolize_keys)
+        @format = :json
+        render 'active_mcp/prompts_get', formats: :json
       else
         @format = :json
         render 'active_mcp/no_method', formats: :json

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

@@ -37,13 +37,13 @@ module ActiveMcp
       end
 
       begin
-        if resource.respond_to?(:text) && content = resource.text
+        if resource.respond_to?(:text) && content = resource.content
           return {
             contents: [
               {
                 uri:,
                 mimeType: resource.class.mime_type,
-                text: formatted(content)
+                text: content
               }
             ]
           }
@@ -65,16 +65,5 @@ module ActiveMcp
         }
       end
     end
-    
-    def formatted(object)
-      case object
-      when String
-        object
-      when Hash
-        object.to_json
-      else
-        object.to_s
-      end
-    end
   end
 end

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

@@ -26,7 +26,7 @@ module ActiveMcp
       end
 
       tool = schema.tools.find do |tc|
-        tc.name == tool_name
+        tc.tool_name == tool_name
       end
       
       unless tool

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

@@ -0,0 +1,12 @@
+json.jsonrpc ActiveMcp::JSON_RPC_VERSION if @format == :jsonrpc
+json.id @id if @format == :jsonrpc && @id.present?
+
+if @format == :jsonrpc
+  json.result do
+    json.description @prompt.class.description
+    json.messages @prompt.messages.map(&:to_h)
+  end
+else
+  json.description @prompt.class.description
+  json.messages @prompt.messages.map(&:to_h)
+end

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

@@ -0,0 +1,22 @@
+json.jsonrpc ActiveMcp::JSON_RPC_VERSION if @format == :jsonrpc
+json.id @id if @format == :jsonrpc && @id.present?
+
+if @format == :jsonrpc
+  json.result do
+    json.prompts do
+      json.array!(@prompts) do |prompt|
+        json.name prompt.prompt_name
+        json.description prompt.description
+        json.arguments prompt.arguments.map { _1.except(:complete) }
+      end
+    end
+  end
+else
+  json.result do
+    json.array!(@prompts) do |prompt|
+      json.name prompt.prompt_name
+      json.description prompt.description
+      json.arguments prompt.arguments.map { _1.except(:complete) }
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ if @format == :jsonrpc
   json.result do
     json.resourceTemplates do
       json.array!(@resource_templates) do |resource|
-        json.name resource.name
+        json.name resource.resource_template_name
         json.uriTemplate resource.uri_template
         json.mimeType resource.mime_type
         json.description resource.description
@@ -15,7 +15,7 @@ if @format == :jsonrpc
 else
   json.result do
     json.array!(@resource_templates) do |resource|
-      json.name resource.name
+      json.name resource.resource_template_name
       json.uriTemplate resource.uri_template
       json.mimeType resource.mime_type
       json.description resource.description

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

@@ -5,7 +5,7 @@ if @format == :jsonrpc
   json.result do
     json.resources do
       json.array!(@resources) do |resource|
-        json.name resource.name
+        json.name resource.resource_name
         json.uri resource.uri
         json.mimeType resource.class.mime_type
         json.description resource.description
@@ -15,7 +15,7 @@ if @format == :jsonrpc
 else
   json.result do
     json.array!(@resources) do |resource|
-      json.name resource.name
+      json.name resource.resource_name
       json.uri resource.uri
       json.mimeType resource.class.mime_type
       json.description resource.description

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

@@ -5,7 +5,7 @@ if @format == :jsonrpc
   json.result do
     json.tools do
       json.array!(@tools) do |tool|
-        json.name tool.name
+        json.name tool.tool_name
         json.description tool.description
         json.inputSchema tool.class.schema
       end
@@ -14,7 +14,7 @@ if @format == :jsonrpc
 else
   json.result do
     json.array!(@tools) do |tool|
-      json.name tool.name
+      json.name tool.tool_name
       json.description tool.description
       json.inputSchema tool.class.schema
     end

data/lib/active_mcp/completion.rb

@@ -11,7 +11,9 @@ module ActiveMcp
         values = resource_class.arguments[arg_name.to_sym].call(value)
         { values:, total: values.length }
       elsif ref_name
-        { values: [], total: 0 }
+        prompt_class = refs.find { _1.prompt_name == ref_name }
+        values = prompt_class.arguments.find { _1[:name] == arg_name.to_sym }[:complete].call(value)
+        { values:, total: values.length }
       end
     end
   end

data/lib/active_mcp/engine.rb

@@ -7,6 +7,7 @@ module ActiveMcp
         Rails.root.join("app", "mcp", "tools"),
         Rails.root.join("app", "mcp", "resources"),
         Rails.root.join("app", "mcp", "resource_templates"),
+        Rails.root.join("app", "mcp", "prompts"),
         Rails.root.join("app", "mcp", "schemas")
       ].each do |tools_path|
         if Dir.exist?(tools_path)

data/lib/active_mcp/message/audio.rb

@@ -0,0 +1,22 @@
+module ActiveMcp
+  module Message
+    class Audio
+      def initialize(role:, data:, mime_type:)
+        @role = role
+        @data = data
+        @mime_type = mime_type
+      end
+
+      def to_h
+        {
+          role: @role,
+          content: {
+            type: "audio",
+            data: Base64.strict_encode64(@data),
+            mimeType: @mime_type
+          }
+        }
+      end
+    end
+  end
+end

data/lib/active_mcp/message/image.rb

@@ -0,0 +1,22 @@
+module ActiveMcp
+  module Message
+    class Image
+      def initialize(role:, data:, mime_type:)
+        @role = role
+        @data = data
+        @mime_type = mime_type
+      end
+
+      def to_h
+        {
+          role: @role,
+          content: {
+            type: "image",
+            data: Base64.strict_encode64(@data),
+            mimeType: @mime_type
+          }
+        }
+      end
+    end
+  end
+end

data/lib/active_mcp/message/resource.rb

@@ -0,0 +1,24 @@
+module ActiveMcp
+  module Message
+    class Resource
+      def initialize(role:, resource:)
+        @role = role
+        @resource = resource
+      end
+
+      def to_h
+        {
+          role: @role,
+          content: {
+            type: "resource",
+            resource: {
+              uri: @resource.uri,
+              mimeType: @resource.class.mime_type,
+              text: @resource.content,
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/active_mcp/message/text.rb

@@ -0,0 +1,20 @@
+module ActiveMcp
+  module Message
+    class Text
+      def initialize(role:, text:)
+        @role = role
+        @text = text
+      end
+
+      def to_h
+        {
+          role: @role,
+          content: {
+            type: "text",
+            text: @text
+          }
+        }
+      end
+    end
+  end
+end

data/lib/active_mcp/prompt/base.rb

@@ -0,0 +1,37 @@
+module ActiveMcp
+  module Prompt
+    class Base
+      class << self
+        attr_reader :arguments
+
+        def argument(name, required: false, description: nil, complete: ->(){})
+          @arguments ||= []
+
+          @arguments << {
+            name:,
+            description:,
+            required:,
+            complete:
+          }
+        end
+      end
+
+      def initialize(*args, context: {})
+      end
+
+      def prompt_name
+      end
+
+      def description
+      end
+
+      def visible?(context: {})
+        true
+      end
+
+      def messages
+        raise NotImplementedError, "#{self.class.name}#messages must be implemented"
+      end
+    end
+  end
+end

data/lib/active_mcp/resource/base.rb

@@ -6,6 +6,15 @@ module ActiveMcp
       class << self
         attr_reader :schema, :arguments
 
+        def resource_template_name
+        end
+  
+        def description
+        end
+
+        def mime_type
+        end
+
         def argument(name, complete)
           @arguments = {}
           @arguments[name] = complete
@@ -15,7 +24,7 @@ module ActiveMcp
       def initialize
       end
 
-      def name
+      def resource_name
       end
 
       def description
@@ -24,6 +33,17 @@ module ActiveMcp
       def visible?(context: {})
         true
       end
+
+      def content
+        case text
+        when String
+          text
+        when Hash
+          text.to_json
+        else
+          text.to_s
+        end
+      end
     end
   end
 end

data/lib/active_mcp/schema/base.rb

@@ -2,7 +2,7 @@ module ActiveMcp
   module Schema
     class Base
       class << self
-        attr_reader :resources, :resource_templates, :tools
+        attr_reader :resources, :resource_templates, :tools, :prompts
 
         def resource(klass)
           @resources ||= []
@@ -18,6 +18,11 @@ module ActiveMcp
           @tools ||= []
           @tools << klass
         end
+
+        def prompt(klass)
+          @prompts ||= []
+          @prompts << klass
+        end
       end
 
       def initialize(context: {})
@@ -25,22 +30,28 @@ module ActiveMcp
       end
 
       def resources
-        self.class.resources.filter do |resource|
+        self.class.resources&.filter do |resource|
           !resource.respond_to?(:visible?) || resource.visible?(context: @context)
         end
       end
 
       def resource_templates
-        self.class.resource_templates.filter do |template|
+        self.class.resource_templates&.filter do |template|
           !template.respond_to?(:visible?) || template.visible?(context: @context)
         end
       end
 
       def tools
-        self.class.tools.filter do |tool|
+        self.class.tools&.filter do |tool|
           !tool.respond_to?(:visible?) || tool.visible?(context: @context)
         end
       end
+
+      def prompts
+        self.class.prompts&.filter do |resource|
+          !resource.respond_to?(:visible?) || resource.visible?(context: @context)
+        end
+      end
     end
   end
 end

data/lib/active_mcp/server/method.rb

@@ -12,5 +12,7 @@ module ActiveMcp
     RESOURCES_READ = "resources/read"
     RESOURCES_TEMPLATES_LIST = "resources/templates/list"
     COMPLETION_COMPLETE = "completion/complete"
+    PROMPTS_LIST = "prompts/list"
+    PROMPTS_GET = "prompts/get"
   end
 end

data/lib/active_mcp/server/protocol_handler.rb

@@ -31,16 +31,6 @@ module ActiveMcp
       private
 
       def handle_request(request)
-        allowed_methods = [
-          Method::INITIALIZE,
-          Method::INITIALIZED,
-          Method::PING
-        ]
-
-        if !@initialized && !allowed_methods.include?(request[:method])
-          return error_response(request[:id], ErrorCode::NOT_INITIALIZED, "Server not initialized")
-        end
-
         case request[:method]
         when Method::INITIALIZE
           handle_initialize(request)
@@ -60,6 +50,10 @@ module ActiveMcp
           handle_read_resource(request)
         when Method::COMPLETION_COMPLETE
           handle_complete(request)
+        when Method::PROMPTS_LIST
+          handle_list_prompts(request)
+        when Method::PROMPTS_GET
+          handle_get_prompt(request)
         else
           error_response(request[:id], ErrorCode::METHOD_NOT_FOUND, "Unknown method: #{request[:method]}")
         end
@@ -88,13 +82,9 @@ module ActiveMcp
           result: {
             protocolVersion: PROTOCOL_VERSION,
             capabilities: {
-              resources: {
-                subscribe: false,
-                listChanged: false
-              },
-              tools: {
-                listChanged: false
-              }
+              resources: {},
+              tools: {},
+              prompts: {},
             },
             serverInfo: {
               name: @server.name,
@@ -191,7 +181,7 @@ module ActiveMcp
 
           success_response(request[:id], result)
         rescue => e
-          Server.("Error reading resource #{uri}", e)
+          Server.log_error("Error reading resource #{uri}", e)
           error_response(request[:id], ErrorCode::INTERNAL_ERROR, "An error occurred while reading the resource")
         end
       end
@@ -206,7 +196,38 @@ module ActiveMcp
           )
           success_response(request[:id], { completion: result[:result] })
         rescue => e
-          Server.("Error reading resource #{uri}", e)
+          Server.log_error("Error reading resource #{uri}", e)
+          error_response(request[:id], ErrorCode::INTERNAL_ERROR, "An error occurred while reading the resource")
+        end
+      end
+
+      def handle_list_prompts(request)
+        begin
+          result = @server.fetch(params: { method: Method::PROMPTS_LIST })
+          success_response(request[:id], { prompts: result[:result] })
+        rescue => e
+          Server.log_error("Error reading resource #{uri}", e)
+          error_response(request[:id], ErrorCode::INTERNAL_ERROR, "An error occurred while reading the resource")
+        end
+      end
+
+      def handle_get_prompt(request)
+        name = request.dig(:params, :name)
+        arguments = request.dig(:params, :arguments)
+        begin
+          result = @server.fetch(
+            params: {
+              method: Method::PROMPTS_GET,
+              params: {
+                name:,
+                arguments:,
+              }
+            }
+          )
+
+          success_response(request[:id], result)
+        rescue => e
+          Server.log_error("Error reading resource #{uri}", e)
           error_response(request[:id], ErrorCode::INTERNAL_ERROR, "An error occurred while reading the resource")
         end
       end

data/lib/active_mcp/tool/base.rb

@@ -26,7 +26,7 @@ module ActiveMcp
       def initialize
       end
 
-      def name
+      def tool_name
       end
 
       def description

data/lib/active_mcp/version.rb

@@ -1,3 +1,3 @@
 module ActiveMcp
-  VERSION = "0.8.0"
+  VERSION = "0.9.1"
 end

data/lib/active_mcp.rb

@@ -6,12 +6,16 @@ require_relative "active_mcp/configuration"
 require_relative "active_mcp/schema/base"
 require_relative "active_mcp/tool/base"
 require_relative "active_mcp/resource/base"
+require_relative "active_mcp/prompt/base"
+require_relative "active_mcp/message/text"
+require_relative "active_mcp/message/image"
+require_relative "active_mcp/message/audio"
+require_relative "active_mcp/message/resource"
 require_relative "active_mcp/server"
 require_relative "active_mcp/completion"
 
 if defined? ::Rails
   require_relative "active_mcp/engine"
-  require_relative "active_mcp/controller/base"
 end
 
 module ActiveMcp

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

@@ -1,5 +1,5 @@
 class <%= class_name %>
-  def name
+  def resource_name
     "<%= file_name %>"
   end
 

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

@@ -1,5 +1,5 @@
 class <%= class_name %> < ActiveMcp::Tool::Base
-  def name
+  def tool_name
     "<%= file_name.humanize %>"
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_mcp
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Moeki Kawakami
@@ -77,6 +77,8 @@ files:
 - 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/prompts_get.json.jbuilder
+- app/views/active_mcp/prompts_list.json.jbuilder
 - app/views/active_mcp/resource_templates_list.json.jbuilder
 - app/views/active_mcp/resources_list.json.jbuilder
 - app/views/active_mcp/resources_read.json.jbuilder
@@ -86,8 +88,12 @@ files:
 - lib/active_mcp.rb
 - lib/active_mcp/completion.rb
 - lib/active_mcp/configuration.rb
-- lib/active_mcp/controller/base.rb
 - lib/active_mcp/engine.rb
+- lib/active_mcp/message/audio.rb
+- lib/active_mcp/message/image.rb
+- lib/active_mcp/message/resource.rb
+- lib/active_mcp/message/text.rb
+- lib/active_mcp/prompt/base.rb
 - lib/active_mcp/resource/base.rb
 - lib/active_mcp/schema/base.rb
 - lib/active_mcp/server.rb

data/lib/active_mcp/controller/base.rb

@@ -1,7 +0,0 @@
-require_relative "../../../app/controllers/active_mcp/base_controller"
-
-module ActiveMcp
-  module Controller
-    Base = ActiveMcp::BaseController
-  end
-end