mcp-rb 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 610a73e9025b6400f091beeec7e0e0b9b51e917ba57b068f7132fd2dad3fa207
-  data.tar.gz: 8a5533dd1abdb1fbdde067facfe0ceeeb50d9fac332ba4ec4c4815a9b8f1a199
+  metadata.gz: 131c29522f8eb44f7f613f51d92db433370d99950dcfcd27340ab9917b306dd3
+  data.tar.gz: a676110b09851f7018205bc012b09a6f22d1c7730555ba569b9b7ae475c06009
 SHA512:
-  metadata.gz: be76a1399e5121d0e0886489630fe7695b9fba3cea55835d6da2d67d5b74d3a714f68c354dbf447e8953f965c0c65e416e12417ee109fe4695f47cc4c940bdc6
-  data.tar.gz: d0ec9f439c4bc497c264241000269b7c5928167f0623a3a34335e6c28b597c95967b38819051a954f96323e861ea6553d218bc639df7b52697185463da1ac158
+  metadata.gz: ebe914ec0fa9ba0ef97650f83454d0fe5bf5c924717365d5cea3bdd73bfb06b5e0ede7d49c6da2caa8d38c5a337bae3c98c22b86d5f1c25740785c66ac195509
+  data.tar.gz: 719f1f95950ca24c0695316af978866e1b8834b5112c962701324d8279faa9e5705151157d23a66e7f9e6572313df18f7c4acfc247037965d059f12bdcacb883

data/CHANGELOG.md

@@ -5,6 +5,39 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2025-02-19
+
+- Allow specifying the version via DSL keyword: https://github.com/funwarioisii/mcp-rb/pull/2
+- Add MCP Client: https://github.com/funwarioisii/mcp-rb/pull/3
+
+### Breaking Changes
+- `MCP::PROTOCOL_VERSION` is moved to `MCP::Constants::PROTOCOL_VERSION`
+  - https://github.com/funwarioisii/mcp-rb/pull/3/commits/caad65500935a8eebfe024dbd25de0d16868c44e
+
+## [0.2.0] - 2025-02-14
+
+### Breaking Changes
+- Unified DSL to block-based style for both tools and resources
+  - Example of new resource style:
+    ```ruby
+    resource "uri" do
+      name "Resource Name"
+      description "Description"
+      mime_type "text/plain"
+      call { "content" }
+    end
+    ```
+  - Example of new tool style:
+    ```ruby
+    tool "greet" do
+      description "Greet someone"
+      argument :name, String, required: true, description: "Name to greet"
+      call do |args|
+        "Hello, #{args[:name]}!"
+      end
+    end
+    ```
+
 ## [0.1.0] - 2025-02-12
 
 ### Added

data/README.md

@@ -19,29 +19,40 @@ require 'mcp'
 
 name "hello-world"
 
-# リソースの定義
-resource "hello://world",
-  name: "Hello World",
-  description: "A simple hello world message" do
-  "Hello, World!"
+# Define a resource
+resource "hello://world" do
+  name "Hello World"
+  description "A simple hello world message"
+  call { "Hello, World!" }
 end
 
-tool "greet",
-  description: "Greet someone by name",
-  input_schema: {
-    type: :object,
-    properties: {
-      name: {
-        type: :string,
-        description: "Name to greet"
-      }
-    },
-    required: [:name]
-  } do |args|
-  "Hello, #{args[:name]}!"
+# Define a tool
+tool "greet" do
+  description "Greet someone by name"
+  argument :name, String, required: true, description: "Name to greet"
+  call do |args|
+    "Hello, #{args[:name]}!"
+  end
 end
 ```
 
+## Supported specifications
+
+Reference: [MCP 2024-11-05](https://spec.modelcontextprotocol.io/specification/2024-11-05/)
+
+- [Base Protocol](https://spec.modelcontextprotocol.io/specification/2024-11-05/basic/)
+  - ping
+  - stdio transport
+- [Server features](https://spec.modelcontextprotocol.io/specification/2024-11-05/server/)
+  - Resources
+    - resources/read
+    - resources/list
+  - Tools
+    - tools/list
+    - tools/call
+
+Any capabilities are not supported yet.
+
 ## Testing
 
 ```bash
@@ -65,3 +76,30 @@ Find broken using `hello_world.rb`
 ```bash
 bundle exec standardrb --fix
 ```
+
+## Release
+
+To release a new version:
+
+1. Update version in `lib/mcp/version.rb`
+2. Update `CHANGELOG.md`
+3. Create a git tag
+
+```bash
+git add .
+git commit -m "Release vx.y.z"
+git tag vx.y.z
+git push --tags
+```
+
+1. Build and push to RubyGems
+
+```bash
+gem build mcp-rb.gemspec
+gem push mcp-rb-*.gem
+```
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md)
+

data/lib/mcp/app/resource.rb

@@ -3,14 +3,64 @@
 module MCP
   class App
     module Resource
-      def register_resource(uri, name:, mime_type: "text/plain", description: "", &block)
-        raise ArgumentError, "Resource name cannot be nil or empty" if uri.nil? || uri.empty?
-        raise ArgumentError, "Block must be provided" unless block_given?
+      def resources
+        @resources ||= {}
+      end
 
-        resources[uri] = {
-          uri:, name:, mime_type:, description:,
-          handler: block
-        }
+      class ResourceBuilder
+        attr_reader :uri, :name, :description, :mime_type, :handler
+
+        def initialize(uri)
+          raise ArgumentError, "Resource URI cannot be nil or empty" if uri.nil? || uri.empty?
+          @uri = uri
+          @name = ""
+          @description = ""
+          @mime_type = "text/plain"
+          @handler = nil
+        end
+
+        # standard:disable Lint/DuplicateMethods,Style/TrivialAccessors
+        def name(value)
+          @name = value
+        end
+        # standard:enable Lint/DuplicateMethods,Style/TrivialAccessors
+
+        # standard:disable Lint/DuplicateMethods,Style/TrivialAccessors
+        def description(text)
+          @description = text
+        end
+        # standard:enable Lint/DuplicateMethods,Style/TrivialAccessors
+
+        # standard:disable Lint/DuplicateMethods,Style/TrivialAccessors
+        def mime_type(value)
+          @mime_type = value
+        end
+        # standard:enable Lint/DuplicateMethods,Style/TrivialAccessors
+
+        def call(&block)
+          @handler = block
+        end
+
+        def to_resource_hash
+          raise ArgumentError, "Handler must be provided" unless @handler
+          raise ArgumentError, "Name must be provided" if @name.empty?
+
+          {
+            uri: @uri,
+            name: @name,
+            mime_type: @mime_type,
+            description: @description,
+            handler: @handler
+          }
+        end
+      end
+
+      def register_resource(uri, &block)
+        builder = ResourceBuilder.new(uri)
+        builder.instance_eval(&block)
+        resource_hash = builder.to_resource_hash
+        resources[uri] = resource_hash
+        resource_hash
       end
 
       def list_resources(cursor: nil, page_size: nil)
@@ -52,10 +102,6 @@ module MCP
 
       private
 
-      def resources
-        @resources ||= {}
-      end
-
       def format_resource(resource)
         {
           uri: resource[:uri],

data/lib/mcp/app/tool.rb

@@ -3,16 +3,74 @@
 module MCP
   class App
     module Tool
-      def register_tool(name, description: "", input_schema: {}, &block)
-        raise ArgumentError, "Tool name cannot be nil or empty" if name.nil? || name.empty?
-        raise ArgumentError, "Block must be provided" unless block_given?
-
-        tools[name] = {
-          name: name,
-          description: description,
-          input_schema: input_schema,
-          handler: block
-        }
+      def tools
+        @tools ||= {}
+      end
+
+      class ToolBuilder
+        attr_reader :name, :description, :arguments, :handler
+
+        def initialize(name)
+          raise ArgumentError, "Tool name cannot be nil or empty" if name.nil? || name.empty?
+          @name = name
+          @description = ""
+          @arguments = {}
+          @required_arguments = []
+          @handler = nil
+        end
+
+        # standard:disable Lint/DuplicateMethods
+        def description(text = nil)
+          return @description if text.nil?
+          @description = text
+        end
+        # standard:enable Lint/DuplicateMethods
+
+        def argument(name, type, required: false, description: "")
+          @arguments[name] = {
+            type: ruby_type_to_schema_type(type),
+            description: description
+          }
+          @required_arguments << name if required
+        end
+
+        def call(&block)
+          @handler = block if block_given?
+        end
+
+        def to_tool_hash
+          raise ArgumentError, "Handler must be provided" unless @handler
+          {
+            name: @name,
+            description: @description,
+            input_schema: {
+              type: :object,
+              properties: @arguments,
+              required: @required_arguments
+            },
+            handler: @handler
+          }
+        end
+
+        private
+
+        def ruby_type_to_schema_type(type)
+          case type.to_s
+          when "String" then :string
+          when "Integer" then :integer
+          when "Float" then :number
+          when "TrueClass", "FalseClass", "Boolean" then :boolean
+          else :object
+          end
+        end
+      end
+
+      def register_tool(name, &block)
+        builder = ToolBuilder.new(name)
+        builder.instance_eval(&block)
+        tool_hash = builder.to_tool_hash
+        tools[name] = tool_hash
+        tool_hash
       end
 
       def list_tools(cursor: nil, page_size: 10)
@@ -32,6 +90,7 @@ module MCP
         raise ArgumentError, "Tool not found: #{name}" unless tool
 
         begin
+          validate_arguments(tool[:input_schema], arguments)
           result = tool[:handler].call(arguments)
           {
             content: [
@@ -57,8 +116,14 @@ module MCP
 
       private
 
-      def tools
-        @tools ||= {}
+      def validate_arguments(schema, arguments)
+        return unless schema[:required]
+
+        schema[:required].each do |required_arg|
+          unless arguments.key?(required_arg)
+            raise ArgumentError, "missing keyword: :#{required_arg}"
+          end
+        end
       end
 
       def format_tool(tool)

data/lib/mcp/client.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "json"
+require "open3"
+require "securerandom"
+require_relative "constants"
+
+module MCP
+  class Client
+    attr_reader :command, :args, :process, :stdin, :stdout, :stderr, :wait_thread
+
+    def initialize(command:, args: [], name: "mcp-client", version: VERSION)
+      @command = command
+      @args = args
+      @process = nil
+      @name = name
+      @version = version
+    end
+
+    def connect
+      return if @process
+
+      start_server
+      initialize_connection
+      self
+    end
+
+    def running? = !@process.nil?
+
+    def list_tools
+      ensure_running
+      send_request({
+        jsonrpc: Constants::JSON_RPC_VERSION,
+        method: Constants::RequestMethods::TOOLS_LIST,
+        params: {},
+        id: SecureRandom.uuid
+      })
+    end
+
+    def call_tool(name:, args: {})
+      ensure_running
+      send_request({
+        jsonrpc: Constants::JSON_RPC_VERSION,
+        method: Constants::RequestMethods::TOOLS_CALL,
+        params: {
+          name: name,
+          arguments: args
+        },
+        id: SecureRandom.uuid
+      })
+    end
+
+    def close
+      return unless @process
+
+      @stdin.close
+      @stdout.close
+      @stderr.close
+      Process.kill("TERM", @process)
+      @wait_thread.join
+      @process = nil
+    rescue IOError, Errno::ESRCH
+      # プロセスが既に終了している場合は無視
+      @process = nil
+    end
+
+    private
+
+    def ensure_running
+      raise "Server process not running. Call #start first." unless running?
+    end
+
+    def initialize_connection
+      response = send_request({
+        jsonrpc: Constants::JSON_RPC_VERSION,
+        method: "initialize",
+        params: {
+          protocolVersion: Constants::PROTOCOL_VERSION,
+          client: {
+            name: @name,
+            version: @version
+          }
+        },
+        id: SecureRandom.uuid
+      })
+
+      @stdin.puts(JSON.generate({
+        jsonrpc: Constants::JSON_RPC_VERSION,
+        method: "notifications/initialized"
+      }))
+
+      response
+    end
+
+    def start_server
+      @stdin, @stdout, @stderr, @wait_thread = Open3.popen3(@command, *@args)
+      @process = @wait_thread.pid
+
+      Thread.new do
+        while (line = @stderr.gets)
+          warn "[MCP Server] #{line}"
+        end
+      rescue IOError
+        # ignore when stream is closed
+      end
+    end
+
+    def send_request(request)
+      @stdin.puts(JSON.generate(request))
+      response = @stdout.gets
+      raise "No response from server" unless response
+
+      result = JSON.parse(response, symbolize_names: true)
+      if result[:error]
+        raise "Server error: #{result[:error][:message]} (#{result[:error][:code]})"
+      end
+
+      result[:result]
+    rescue JSON::ParserError => e
+      raise "Invalid JSON response: #{e.message}"
+    end
+  end
+end

data/lib/mcp/constants.rb

@@ -3,6 +3,7 @@
 module MCP
   module Constants
     JSON_RPC_VERSION = "2.0"
+    PROTOCOL_VERSION = "2024-11-05"
 
     module ErrorCodes
       NOT_INITIALIZED = -32_002

data/lib/mcp/delegator.rb

@@ -15,6 +15,6 @@ module MCP
       end
     end
 
-    delegate :name, :resource, :tool
+    delegate :name, :version, :resource, :tool
   end
 end

data/lib/mcp/server.rb

@@ -3,32 +3,39 @@
 require "json"
 require "English"
 require "uri"
+require_relative "constants"
 
 module MCP
   class Server
-    attr_accessor :name
+    attr_writer :name, :version
     attr_reader :initialized
 
-    def initialize(name:, version: VERSION)
+    def initialize(name:, version: "0.1.0")
       @name = name
       @version = version
       @app = App.new
       @initialized = false
-      @supported_protocol_versions = [PROTOCOL_VERSION]
+      @supported_protocol_versions = [Constants::PROTOCOL_VERSION]
     end
 
-    def name(value = nil) # standard:disable Lint/DuplicateMethods
+    def name(value = nil)
       return @name if value.nil?
 
       @name = value
     end
 
-    def tool(name, description: "", input_schema: {}, &block)
-      @app.register_tool(name, description: description, input_schema: input_schema, &block)
+    def version(value = nil)
+      return @version if value.nil?
+
+      @version = value
+    end
+
+    def tool(name, &block)
+      @app.register_tool(name, &block)
     end
 
-    def resource(uri, name:, mime_type: "text/plain", description: "", &block)
-      @app.register_resource(uri, name: name, mime_type: mime_type, description: description, &block)
+    def resource(uri, &block)
+      @app.register_resource(uri, &block)
     end
 
     def run
@@ -113,7 +120,7 @@ module MCP
         jsonrpc: MCP::Constants::JSON_RPC_VERSION,
         id: request[:id],
         result: {
-          protocolVersion: PROTOCOL_VERSION,
+          protocolVersion: Constants::PROTOCOL_VERSION,
           capabilities: {
             logging: {},
             prompts: {

data/lib/mcp/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module MCP
-  PROTOCOL_VERSION = "2024-11-05"
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/mcp.rb

@@ -8,6 +8,7 @@ require_relative "mcp/constants"
 require_relative "mcp/app"
 require_relative "mcp/server"
 require_relative "mcp/delegator"
+require_relative "mcp/client"
 
 module MCP
   class << self

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mcp-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - funwarioisii
 bindir: bin
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-02-19 00:00:00.000000000 Z
 dependencies: []
 description: MCP-RB is a Ruby framework that provides a Sinatra-like DSL for implementing
   Model Context Protocol servers.
@@ -24,6 +24,7 @@ files:
 - lib/mcp/app.rb
 - lib/mcp/app/resource.rb
 - lib/mcp/app/tool.rb
+- lib/mcp/client.rb
 - lib/mcp/constants.rb
 - lib/mcp/delegator.rb
 - lib/mcp/server.rb
@@ -49,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A lightweight Ruby framework for implementing MCP (Model Context Protocol)
   servers