ruby-mcp-client 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16280a305c2b9cd19ecc2a71b8f10d3805644015f34f7eaec28d5846f12fa1db
-  data.tar.gz: 48a791c3a88255c25078234819024dace993f7cfc564485f48680a8768b81238
+  metadata.gz: fbd3caf1e80f6c2caf625495072211b827ae08e3542fa33306537918d0b6eb5f
+  data.tar.gz: 1eea548ba10e7de3fec68a92d449e4552fde3c5920af045e2e828925dba2aad7
 SHA512:
-  metadata.gz: d4155463bcc691725b3a88e29dbb7df75a5b05a9ca7693d12a4fcc6f43bb57df06966089042dcaebb6f9f0a3b429a1eaa3138bb478ad161aad98163eb6de2763
-  data.tar.gz: 6acb25bd0f1c72d640570823c262f548bda1f09322c137789ad36d5950dc80eda6d66e707b0c69229805ffdb575aea086ae999747d74aef9304ad65c46e67039
+  metadata.gz: e8eae783bd1e6a4db013a934e0686641befaec435fb288531ce85899efc0a66023d3d174dedffae21f75089f406f6368f286f13644701fbdee747492b795535b
+  data.tar.gz: 534cc5c88f8f3737c5fc3e684174980af74ac18398532e4b5698490b451b5fc5ff0831ca48639119445c71f4afa94ba3fca94ff81edfa03d1e3ba34a73c4f1b1

data/README.md

@@ -298,7 +298,7 @@ You can define MCP server configurations in JSON files for easier management:
 }
 ```
 
-A simpler example used in the Playwright demo (found in `examples/playwright_server_definition.json`):
+A simpler example used in the Playwright demo (found in `examples/sample_server_definition.json`):
 
 ```json
 {

data/lib/mcp_client/server_sse.rb

@@ -48,6 +48,7 @@ module MCPClient
       @connection_established = false
       @connection_cv = @mutex.new_cond
       @initialized = false
+      @auth_error = nil
       # Whether to use SSE transport; may disable if handshake fails
       @use_sse = true
     end
@@ -131,25 +132,30 @@ module MCPClient
     # @return [Boolean] true if connection was successful
     # @raise [MCPClient::Errors::ConnectionError] if connection fails
     def connect
-      @mutex.synchronize do
-        return true if @connection_established
+      return true if @mutex.synchronize { @connection_established }
 
-        # Start SSE listener using Faraday HTTP client
+      begin
         start_sse_thread
+        effective_timeout = [@read_timeout || 30, 30].min
+        wait_for_connection(timeout: effective_timeout)
+        true
+      rescue MCPClient::Errors::ConnectionError => e
+        cleanup
+        # Check for stored auth error first, as it's more specific
+        auth_error = @mutex.synchronize { @auth_error }
+        raise MCPClient::Errors::ConnectionError, auth_error if auth_error
+
+        raise MCPClient::Errors::ConnectionError, e.message if e.message.include?('Authorization failed')
+
+        raise MCPClient::Errors::ConnectionError, "Failed to connect to MCP server at #{@base_url}: #{e.message}"
+      rescue StandardError => e
+        cleanup
+        # Check for stored auth error
+        auth_error = @mutex.synchronize { @auth_error }
+        raise MCPClient::Errors::ConnectionError, auth_error if auth_error
 
-        timeout = 10
-        success = @connection_cv.wait(timeout) { @connection_established }
-
-        unless success
-          cleanup
-          raise MCPClient::Errors::ConnectionError, 'Timed out waiting for SSE connection to be established'
-        end
-
-        @connection_established
+        raise MCPClient::Errors::ConnectionError, "Failed to connect to MCP server at #{@base_url}: #{e.message}"
       end
-    rescue StandardError => e
-      cleanup
-      raise MCPClient::Errors::ConnectionError, "Failed to connect to MCP server at #{@base_url}: #{e.message}"
     end
 
     # Clean up the server connection
@@ -171,6 +177,7 @@ module MCPClient
         @tools = nil
         @connection_established = false
         @sse_connected = false
+        # Don't clear auth error as we need it for reporting the correct error
       end
     end
 
@@ -222,6 +229,25 @@ module MCPClient
 
     private
 
+    # Wait for SSE connection to be established with periodic checks
+    # @param timeout [Integer] Maximum time to wait in seconds
+    # @raise [MCPClient::Errors::ConnectionError] if timeout expires
+    def wait_for_connection(timeout:)
+      @mutex.synchronize do
+        deadline = Time.now + timeout
+
+        until @connection_established
+          remaining = [1, deadline - Time.now].min
+          break if remaining <= 0 || @connection_cv.wait(remaining) { @connection_established }
+        end
+
+        unless @connection_established
+          cleanup
+          raise MCPClient::Errors::ConnectionError, 'Timed out waiting for SSE connection to be established'
+        end
+      end
+    end
+
     # Ensure SSE initialization handshake has been performed
     def ensure_initialized
       return if @initialized
@@ -253,34 +279,85 @@ module MCPClient
       @capabilities = result['capabilities'] if result.key?('capabilities')
     end
 
+    # Set up the SSE connection
+    # @param uri [URI] The parsed base URL
+    # @return [Faraday::Connection] The configured Faraday connection
+    def setup_sse_connection(uri)
+      sse_base = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+
+      @sse_conn ||= Faraday.new(url: sse_base) do |f|
+        f.options.open_timeout = 10
+        f.options.timeout = nil
+        f.request :retry, max: @max_retries, interval: @retry_backoff, backoff_factor: 2
+        f.adapter Faraday.default_adapter
+      end
+
+      # Use response handling with status check
+      @sse_conn.builder.use Faraday::Response::RaiseError
+      @sse_conn
+    end
+
+    # Handle authorization errors from Faraday
+    # @param error [Faraday::Error] The authorization error
+    # @raise [MCPClient::Errors::ConnectionError] with appropriate message
+    def handle_sse_auth_error(error)
+      error_message = "Authorization failed: HTTP #{error.response[:status]}"
+      @logger.error(error_message)
+
+      @mutex.synchronize do
+        @auth_error = error_message
+        @connection_established = false
+        @connection_cv.broadcast
+      end
+      raise MCPClient::Errors::ConnectionError, error_message
+    end
+
+    # Reset connection state and signal waiting threads
+    def reset_connection_state
+      @mutex.synchronize do
+        @connection_established = false
+        @connection_cv.broadcast
+      end
+    end
+
     # Start the SSE thread to listen for events
     def start_sse_thread
       return if @sse_thread&.alive?
 
       @sse_thread = Thread.new do
         uri = URI.parse(@base_url)
-        sse_base = "#{uri.scheme}://#{uri.host}:#{uri.port}"
         sse_path = uri.request_uri
+        conn = setup_sse_connection(uri)
 
-        @sse_conn ||= Faraday.new(url: sse_base) do |f|
-          f.options.open_timeout = 10
-          f.options.timeout = nil
-          f.adapter Faraday.default_adapter
+        # Reset connection state
+        @mutex.synchronize do
+          @sse_connected = false
+          @connection_established = false
         end
 
-        @sse_conn.get(sse_path) do |req|
-          @headers.each { |k, v| req.headers[k] = v }
-          req.options.on_data = proc do |chunk, _bytes|
-            @logger.debug("SSE chunk received: #{chunk.inspect}")
-            process_sse_chunk(chunk.dup)
+        begin
+          conn.get(sse_path) do |req|
+            @headers.each { |k, v| req.headers[k] = v }
+
+            req.options.on_data = proc do |chunk, _bytes|
+              process_sse_chunk(chunk.dup) if chunk && !chunk.empty?
+            end
           end
+        rescue Faraday::UnauthorizedError, Faraday::ForbiddenError => e
+          handle_sse_auth_error(e)
+        rescue Faraday::Error => e
+          @logger.error("Failed SSE connection: #{e.message}")
+          raise
         end
-      rescue StandardError
-        # On any SSE thread error, signal connection established to unblock connect
-        @mutex.synchronize do
-          @connection_established = true
-          @connection_cv.broadcast
-        end
+      rescue MCPClient::Errors::ConnectionError => e
+        # Re-raise connection errors to propagate them
+        # Signal connect method to stop waiting
+        reset_connection_state
+        raise e
+      rescue StandardError => e
+        @logger.error("SSE connection error: #{e.message}")
+        # Signal connect method to avoid deadlock
+        reset_connection_state
       ensure
         @mutex.synchronize { @sse_connected = false }
       end
@@ -290,18 +367,126 @@ module MCPClient
     # @param chunk [String] the chunk to process
     def process_sse_chunk(chunk)
       @logger.debug("Processing SSE chunk: #{chunk.inspect}")
-      local_buffer = nil
 
+      # Check for direct JSON error responses (which aren't proper SSE events)
+      if chunk.start_with?('{') && chunk.include?('"error"') &&
+         (chunk.include?('Unauthorized') || chunk.include?('authentication'))
+        begin
+          data = JSON.parse(chunk)
+          if data['error']
+            error_message = data['error']['message'] || 'Unknown server error'
+
+            @mutex.synchronize do
+              @auth_error = "Authorization failed: #{error_message}"
+
+              @connection_established = false
+              @connection_cv.broadcast
+            end
+
+            raise MCPClient::Errors::ConnectionError, "Authorization failed: #{error_message}"
+          end
+        rescue JSON::ParserError
+          # Not valid JSON, process normally
+        end
+      end
+
+      event_buffers = nil
       @mutex.synchronize do
         @buffer += chunk
 
+        # Extract all complete events from the buffer
+        event_buffers = []
         while (event_end = @buffer.index("\n\n"))
           event_data = @buffer.slice!(0, event_end + 2)
-          local_buffer = event_data
+          event_buffers << event_data
         end
       end
 
-      parse_and_handle_sse_event(local_buffer) if local_buffer
+      # Process extracted events outside the mutex to avoid deadlocks
+      event_buffers&.each { |event_data| parse_and_handle_sse_event(event_data) }
+    end
+
+    # Handle SSE endpoint event
+    # @param data [String] The endpoint path
+    def handle_endpoint_event(data)
+      @mutex.synchronize do
+        @rpc_endpoint = data
+        @sse_connected = true
+        @connection_established = true
+        @connection_cv.broadcast
+      end
+    end
+
+    # Check if the error represents an authorization error
+    # @param error_message [String] The error message from the server
+    # @param error_code [Integer, nil] The error code if available
+    # @return [Boolean] True if it's an authorization error
+    def authorization_error?(error_message, error_code)
+      return true if error_message.include?('Unauthorized') || error_message.include?('authentication')
+      return true if [401, -32_000].include?(error_code)
+
+      false
+    end
+
+    # Handle authorization error in SSE message
+    # @param error_message [String] The error message from the server
+    def handle_sse_auth_error_message(error_message)
+      @mutex.synchronize do
+        @auth_error = "Authorization failed: #{error_message}"
+        @connection_established = false
+        @connection_cv.broadcast
+      end
+
+      raise MCPClient::Errors::ConnectionError, "Authorization failed: #{error_message}"
+    end
+
+    # Process error messages in SSE responses
+    # @param data [Hash] The parsed SSE message data
+    def process_error_in_message(data)
+      return unless data['error']
+
+      error_message = data['error']['message'] || 'Unknown server error'
+      error_code = data['error']['code']
+
+      # Handle unauthorized errors (close connection immediately)
+      handle_sse_auth_error_message(error_message) if authorization_error?(error_message, error_code)
+
+      @logger.error("Server error: #{error_message}")
+      true # Error was processed
+    end
+
+    # Process JSON-RPC notifications
+    # @param data [Hash] The parsed SSE message data
+    # @return [Boolean] True if a notification was processed
+    def process_notification(data)
+      return false unless data['method'] && !data.key?('id')
+
+      @notification_callback&.call(data['method'], data['params'])
+      true
+    end
+
+    # Process JSON-RPC responses
+    # @param data [Hash] The parsed SSE message data
+    # @return [Boolean] True if a response was processed
+    def process_response(data)
+      return false unless data['id']
+
+      @mutex.synchronize do
+        # Store tools data if present
+        @tools_data = data['result']['tools'] if data['result'] && data['result']['tools']
+
+        # Store response for the waiting request
+        if data['error']
+          @sse_results[data['id']] = {
+            'isError' => true,
+            'content' => [{ 'type' => 'text', 'text' => data['error'].to_json }]
+          }
+        elsif data['result']
+          @sse_results[data['id']] = data['result']
+        end
+      end
+
+      true
     end
 
     # Parse and handle an SSE event
@@ -312,38 +497,35 @@ module MCPClient
 
       case event[:event]
       when 'endpoint'
-        ep = event[:data]
-        @mutex.synchronize do
-          @rpc_endpoint = ep
-          @connection_established = true
-          @connection_cv.broadcast
-        end
+        handle_endpoint_event(event[:data])
+      when 'ping'
+        # Received ping event, no action needed
       when 'message'
-        begin
-          data = JSON.parse(event[:data])
-          # Dispatch JSON-RPC notifications (no id, has method)
-          if data['method'] && !data.key?('id')
-            @notification_callback&.call(data['method'], data['params'])
-            return
-          end
+        handle_message_event(event)
+      end
+    end
 
-          @mutex.synchronize do
-            @tools_data = data['result']['tools'] if data['result'] && data['result']['tools']
-
-            if data['id']
-              if data['error']
-                @sse_results[data['id']] = {
-                  'isError' => true,
-                  'content' => [{ 'type' => 'text', 'text' => data['error'].to_json }]
-                }
-              elsif data['result']
-                @sse_results[data['id']] = data['result']
-              end
-            end
-          end
-        rescue JSON::ParserError
-          nil
-        end
+    # Handle a message event from SSE
+    # @param event [Hash] The parsed SSE event
+    def handle_message_event(event)
+      return if event[:data].empty?
+
+      begin
+        data = JSON.parse(event[:data])
+
+        # Process the message in order of precedence
+        return if process_error_in_message(data)
+
+        return if process_notification(data)
+
+        process_response(data)
+      rescue MCPClient::Errors::ConnectionError
+        # Re-raise connection errors to propagate to the calling code
+        raise
+      rescue JSON::ParserError => e
+        @logger.warn("Failed to parse JSON from event data: #{e.message}")
+      rescue StandardError => e
+        @logger.error("Error processing SSE event: #{e.message}")
       end
     end
 
@@ -351,14 +533,19 @@ module MCPClient
     # @param event_data [String] the event data to parse
     # @return [Hash, nil] the parsed event, or nil if the event is invalid
     def parse_sse_event(event_data)
-      @logger.debug("Parsing SSE event data: #{event_data.inspect}")
       event = { event: 'message', data: '', id: nil }
       data_lines = []
+      has_content = false
 
       event_data.each_line do |line|
         line = line.chomp
         next if line.empty?
 
+        # Skip SSE comments (lines starting with colon)
+        next if line.start_with?(':')
+
+        has_content = true
+
         if line.start_with?('event:')
           event[:event] = line[6..].strip
         elsif line.start_with?('data:')
@@ -369,8 +556,9 @@ module MCPClient
       end
 
       event[:data] = data_lines.join("\n")
-      @logger.debug("Parsed SSE event: #{event.inspect}")
-      event[:data].empty? ? nil : event
+
+      # Return the event even if data is empty as long as we had non-comment content
+      has_content ? event : nil
     end
 
     # Request the tools list using JSON-RPC

data/lib/mcp_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mcp-client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Szymon Kurcab
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-26 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday