ruby-mcp-client 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79a86302428257274c4e620fae0b7ad45c6229cf381a956ef3b0a7e736f17f62
-  data.tar.gz: 80727b0aa48a992054dafd7c484eb611404b47d878ef2869e59e937a815718dc
+  metadata.gz: 16280a305c2b9cd19ecc2a71b8f10d3805644015f34f7eaec28d5846f12fa1db
+  data.tar.gz: 48a791c3a88255c25078234819024dace993f7cfc564485f48680a8768b81238
 SHA512:
-  metadata.gz: 977acc1ae8ca48a17b7827f006ed82578eb7bc24bf9ba08b03e77493e3447febc82287242a410861fb675b1fb74b0b67525dc4f92c9f8b448cd1cad2e3afc875
-  data.tar.gz: f940ed03a52065a5d8687d1722a588693d69a9c69f820771b328fed3b1bb69068fc7110dbedc745ea4fc42d047afa8afe975b2ed821aa5d33ac8c4e25fac9da7
+  metadata.gz: d4155463bcc691725b3a88e29dbb7df75a5b05a9ca7693d12a4fcc6f43bb57df06966089042dcaebb6f9f0a3b429a1eaa3138bb478ad161aad98163eb6de2763
+  data.tar.gz: 6acb25bd0f1c72d640570823c262f548bda1f09322c137789ad36d5950dc80eda6d66e707b0c69229805ffdb575aea086ae999747d74aef9304ad65c46e67039

data/README.md

@@ -56,10 +56,22 @@ client = MCPClient.create_client(
       retries: 3,       # Optional number of retry attempts (default: 0)
       retry_backoff: 1  # Optional backoff delay in seconds (default: 1)
       # Native support for tool streaming via call_tool_streaming method
-    )
-  ]
+)  ]
 )
 
+# Or load server definitions from a JSON file
+client = MCPClient.create_client(
+  server_definition_file: 'path/to/server_definition.json'
+)
+
+# MCP server configuration JSON format can be:
+# 1. A single server object: 
+#    { "type": "sse", "url": "http://example.com/sse" }
+# 2. An array of server objects: 
+#    [{ "type": "stdio", "command": "npx server" }, { "type": "sse", "url": "http://..." }]
+# 3. An object with "mcpServers" key containing named servers:
+#    { "mcpServers": { "server1": { "type": "sse", "url": "http://..." } } }
+
 # List available tools
 tools = client.list_tools
 
@@ -260,6 +272,62 @@ This client works with any MCP-compatible server, including:
 - [@playwright/mcp](https://www.npmjs.com/package/@playwright/mcp) - Browser automation
 - Custom servers implementing the MCP protocol
 
+### Server Definition Files
+
+You can define MCP server configurations in JSON files for easier management:
+
+```json
+{
+  "mcpServers": {
+    "playwright": {
+      "type": "sse",
+      "url": "http://localhost:8931/sse",
+      "headers": {
+        "Authorization": "Bearer TOKEN"
+      }
+    },
+    "filesystem": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/dir"],
+      "env": {
+        "DEBUG": "true"
+      }
+    }
+  }
+}
+```
+
+A simpler example used in the Playwright demo (found in `examples/playwright_server_definition.json`):
+
+```json
+{
+  "mcpServers": {
+    "playwright": {
+      "url": "http://localhost:8931/sse",
+      "headers": {},
+      "comment": "Local Playwright MCP Server running on port 8931"
+    }
+  }
+}
+```
+
+Load this configuration with:
+
+```ruby
+client = MCPClient.create_client(server_definition_file: 'path/to/definition.json')
+```
+
+The JSON format supports:
+1. A single server object: `{ "type": "sse", "url": "..." }`
+2. An array of server objects: `[{ "type": "stdio", ... }, { "type": "sse", ... }]`
+3. An object with named servers under `mcpServers` key (as shown above)
+
+Special configuration options:
+- `comment` and `description` are reserved keys that are ignored during parsing and can be used for documentation
+- Server type can be inferred from the presence of either `command` (for stdio) or `url` (for SSE)
+- All string values in arrays (like `args`) are automatically converted to strings
+
 ## Key Features
 
 ### Client Features
@@ -274,6 +342,7 @@ This client works with any MCP-compatible server, including:
 - **Server notifications** - Support for JSON-RPC notifications
 - **Custom RPC methods** - Send any custom JSON-RPC method
 - **Consistent error handling** - Rich error types for better exception handling
+- **JSON configuration** - Support for server definition files in JSON format
 
 ### Server-Sent Events (SSE) Implementation
 

data/lib/mcp_client/config_parser.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'logger'
+
+module MCPClient
+  # Parses MCP server definition JSON files into configuration hashes
+  class ConfigParser
+    # Reserved JSON keys that shouldn't be included in final config
+    RESERVED_KEYS = %w[comment description].freeze
+
+    # @param file_path [String] path to JSON file containing 'mcpServers' definitions
+    # @param logger [Logger, nil] optional logger for warnings
+    def initialize(file_path, logger: nil)
+      @file_path = file_path
+      @logger = logger || Logger.new($stdout, level: Logger::WARN)
+    end
+
+    # Parse the JSON config and return a mapping of server names to clean config hashes
+    # @return [Hash<String, Hash>] server name => config hash with symbol keys
+    def parse
+      content = File.read(@file_path)
+      data = JSON.parse(content)
+
+      servers_data = extract_servers_data(data)
+      servers_data = filter_reserved_keys(servers_data)
+
+      result = {}
+      servers_data.each do |server_name, config|
+        next unless validate_server_config(config, server_name)
+
+        server_config = process_server_config(config, server_name)
+        result[server_name] = server_config if server_config
+      end
+
+      result
+    rescue Errno::ENOENT
+      raise Errno::ENOENT, "Server definition file not found: #{@file_path}"
+    rescue JSON::ParserError => e
+      raise JSON::ParserError, "Invalid JSON in #{@file_path}: #{e.message}"
+    end
+
+    # Extract server data from parsed JSON
+    # @param data [Object] parsed JSON data
+    # @return [Hash] normalized server data
+    def extract_servers_data(data)
+      if data.is_a?(Hash) && data.key?('mcpServers') && data['mcpServers'].is_a?(Hash)
+        data['mcpServers']
+      elsif data.is_a?(Array)
+        h = {}
+        data.each_with_index { |cfg, idx| h[idx.to_s] = cfg }
+        h
+      elsif data.is_a?(Hash)
+        { '0' => data }
+      else
+        @logger.warn("Invalid root JSON structure in #{@file_path}: #{data.class}")
+        {}
+      end
+    end
+
+    # Validate server configuration is a hash
+    # @param config [Object] server configuration to validate
+    # @param server_name [String] name of the server
+    # @return [Boolean] true if valid, false otherwise
+    def validate_server_config(config, server_name)
+      return true if config.is_a?(Hash)
+
+      @logger.warn("Configuration for server '#{server_name}' is not an object; skipping.")
+      false
+    end
+
+    # Process a single server configuration
+    # @param config [Hash] server configuration to process
+    # @param server_name [String] name of the server
+    # @return [Hash, nil] processed configuration or nil if invalid
+    def process_server_config(config, server_name)
+      type = determine_server_type(config, server_name)
+      return nil unless type
+
+      clean = { type: type.to_s }
+      case type.to_s
+      when 'stdio'
+        parse_stdio_config(clean, config, server_name)
+      when 'sse'
+        return nil unless parse_sse_config(clean, config, server_name)
+      else
+        @logger.warn("Unrecognized type '#{type}' for server '#{server_name}'; skipping.")
+        return nil
+      end
+
+      clean
+    end
+
+    # Determine the type of server from its configuration
+    # @param config [Hash] server configuration
+    # @param server_name [String] name of the server for logging
+    # @return [String, nil] determined server type or nil if cannot be determined
+    def determine_server_type(config, server_name)
+      type = config['type']
+      return type if type
+
+      inferred_type = if config.key?('command') || config.key?('args') || config.key?('env')
+                        'stdio'
+                      elsif config.key?('url')
+                        'sse'
+                      end
+
+      if inferred_type
+        @logger.warn("'type' not specified for server '#{server_name}', inferring as '#{inferred_type}'.")
+        return inferred_type
+      end
+
+      @logger.warn("Could not determine type for server '#{server_name}' (missing 'command' or 'url'); skipping.")
+      nil
+    end
+
+    private
+
+    # Parse stdio-specific configuration
+    # @param clean [Hash] clean configuration hash to update
+    # @param config [Hash] raw configuration from JSON
+    # @param server_name [String] name of the server for error reporting
+    def parse_stdio_config(clean, config, server_name)
+      # Command is required
+      cmd = config['command']
+      unless cmd.is_a?(String)
+        @logger.warn("'command' for server '#{server_name}' is not a string; converting to string.")
+        cmd = cmd.to_s
+      end
+
+      # Args are optional
+      args = config['args']
+      if args.is_a?(Array)
+        args = args.map(&:to_s)
+      elsif args
+        @logger.warn("'args' for server '#{server_name}' is not an array; treating as single argument.")
+        args = [args.to_s]
+      else
+        args = []
+      end
+
+      # Environment variables are optional
+      env = config['env']
+      env = env.is_a?(Hash) ? env.transform_keys(&:to_s) : {}
+
+      # Update clean config
+      clean[:command] = cmd
+      clean[:args] = args
+      clean[:env] = env
+    end
+
+    # Parse SSE-specific configuration
+    # @param clean [Hash] clean configuration hash to update
+    # @param config [Hash] raw configuration from JSON
+    # @param server_name [String] name of the server for error reporting
+    # @return [Boolean] true if parsing succeeded, false if required elements are missing
+    def parse_sse_config(clean, config, server_name)
+      # URL is required
+      source = config['url']
+      unless source
+        @logger.warn("SSE server '#{server_name}' is missing required 'url' property; skipping.")
+        return false
+      end
+
+      unless source.is_a?(String)
+        @logger.warn("'url' for server '#{server_name}' is not a string; converting to string.")
+        source = source.to_s
+      end
+
+      # Headers are optional
+      headers = config['headers']
+      headers = headers.is_a?(Hash) ? headers.transform_keys(&:to_s) : {}
+
+      # Update clean config
+      clean[:url] = source
+      clean[:headers] = headers
+      true
+    end
+
+    # Filter out reserved keys from configuration objects
+    # @param data [Hash] configuration data
+    # @return [Hash] filtered configuration data
+    def filter_reserved_keys(data)
+      return data unless data.is_a?(Hash)
+
+      result = {}
+      data.each do |key, value|
+        # Skip reserved keys at server level
+        next if RESERVED_KEYS.include?(key)
+
+        # If value is a hash, recursively filter its keys too
+        if value.is_a?(Hash)
+          filtered_value = value.dup
+          RESERVED_KEYS.each { |reserved| filtered_value.delete(reserved) }
+          result[key] = filtered_value
+        else
+          result[key] = value
+        end
+      end
+      result
+    end
+  end
+end

data/lib/mcp_client/version.rb

@@ -2,5 +2,5 @@
 
 module MCPClient
   # Current version of the MCP client gem
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/lib/mcp_client.rb

@@ -9,6 +9,7 @@ require_relative 'mcp_client/server_sse'
 require_relative 'mcp_client/server_factory'
 require_relative 'mcp_client/client'
 require_relative 'mcp_client/version'
+require_relative 'mcp_client/config_parser'
 
 # Model Context Protocol (MCP) Client module
 # Provides a standardized way for agents to communicate with external tools and services
@@ -16,9 +17,31 @@ require_relative 'mcp_client/version'
 module MCPClient
   # Create a new MCPClient client
   # @param mcp_server_configs [Array<Hash>] configurations for MCP servers
+  # @param server_definition_file [String, nil] optional path to a JSON file defining server configurations
+  #   The JSON may be a single server object or an array of server objects.
   # @return [MCPClient::Client] new client instance
-  def self.create_client(mcp_server_configs: [])
-    MCPClient::Client.new(mcp_server_configs: mcp_server_configs)
+  def self.create_client(mcp_server_configs: [], server_definition_file: nil)
+    require 'json'
+    # Start with any explicit configs provided
+    configs = Array(mcp_server_configs)
+    # Load additional configs from a JSON file if specified
+    if server_definition_file
+      # Parse JSON definitions into clean config hashes
+      parser = MCPClient::ConfigParser.new(server_definition_file)
+      parsed = parser.parse
+      parsed.each_value do |cfg|
+        case cfg[:type].to_s
+        when 'stdio'
+          # Build command list with args
+          cmd_list = [cfg[:command]] + Array(cfg[:args])
+          configs << MCPClient.stdio_config(command: cmd_list)
+        when 'sse'
+          # Use 'url' from parsed config as 'base_url' for SSE config
+          configs << MCPClient.sse_config(base_url: cfg[:url], headers: cfg[:headers] || {})
+        end
+      end
+    end
+    MCPClient::Client.new(mcp_server_configs: configs)
   end
 
   # Create a standard server configuration for stdio
@@ -35,13 +58,17 @@ module MCPClient
   # @param base_url [String] base URL for the server
   # @param headers [Hash] HTTP headers to include in requests
   # @param read_timeout [Integer] read timeout in seconds (default: 30)
+  # @param retries [Integer] number of retry attempts (default: 0)
+  # @param retry_backoff [Integer] backoff delay in seconds (default: 1)
   # @return [Hash] server configuration
-  def self.sse_config(base_url:, headers: {}, read_timeout: 30)
+  def self.sse_config(base_url:, headers: {}, read_timeout: 30, retries: 0, retry_backoff: 1)
     {
       type: 'sse',
       base_url: base_url,
       headers: headers,
-      read_timeout: read_timeout
+      read_timeout: read_timeout,
+      retries: retries,
+      retry_backoff: retry_backoff
     }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mcp-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Szymon Kurcab
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-25 00:00:00.000000000 Z
+date: 2025-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -106,6 +106,7 @@ files:
 - README.md
 - lib/mcp_client.rb
 - lib/mcp_client/client.rb
+- lib/mcp_client/config_parser.rb
 - lib/mcp_client/errors.rb
 - lib/mcp_client/server_base.rb
 - lib/mcp_client/server_factory.rb