ruby-mcp-client 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd3caf1e80f6c2caf625495072211b827ae08e3542fa33306537918d0b6eb5f
-  data.tar.gz: 1eea548ba10e7de3fec68a92d449e4552fde3c5920af045e2e828925dba2aad7
+  metadata.gz: 2ec468ae4d2033287bfc89a788e87acc878ab833552e98bef88c95176fa6a906
+  data.tar.gz: d6f2f676be6932d8dbe641df40674aa77ef64d1296d9fdf4eb7c892537f2fa0c
 SHA512:
-  metadata.gz: e8eae783bd1e6a4db013a934e0686641befaec435fb288531ce85899efc0a66023d3d174dedffae21f75089f406f6368f286f13644701fbdee747492b795535b
-  data.tar.gz: 534cc5c88f8f3737c5fc3e684174980af74ac18398532e4b5698490b451b5fc5ff0831ca48639119445c71f4afa94ba3fca94ff81edfa03d1e3ba34a73c4f1b1
+  metadata.gz: 49f5427d6ffc9bc5632bed9b56e4c03e70ce4894d087331f12fd340b60ce82a539b9b2a362c1ce8d0b9686d9d9a4dae4bea3d11ec732b8a0ae34a3e898ff43b2
+  data.tar.gz: 3e32823ef422661fbcf507caf141d0ce65aedd0661ecb54f3b2a287565b630049d2acdfc4bb7b9a93a965e75403b635e43eb21259f035d8b82810f58e0fff304

data/README.md

@@ -36,6 +36,7 @@ with popular AI services with built-in conversions:
 
 - `to_openai_tools()` - Formats tools for OpenAI API
 - `to_anthropic_tools()` - Formats tools for Anthropic Claude API
+- `to_google_tools()` - Formats tools for Google Vertex AI API (automatically removes "$schema" keys not accepted by Vertex AI)
 
 ## Usage
 
@@ -53,6 +54,8 @@ client = MCPClient.create_client(
       base_url: 'https://api.example.com/sse',
       headers: { 'Authorization' => 'Bearer YOUR_TOKEN' },
       read_timeout: 30, # Optional timeout in seconds (default: 30)
+      ping: 10,         # Optional ping interval in seconds of inactivity (default: 10)
+                        # Connection closes automatically after inactivity (2.5x ping interval)
       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
@@ -98,6 +101,7 @@ end
 # Format tools for specific AI services
 openai_tools = client.to_openai_tools
 anthropic_tools = client.to_anthropic_tools
+google_tools = client.to_google_tools
 
 # Register for server notifications
 client.on_notification do |server, method, params|
@@ -139,7 +143,10 @@ sse_client = MCPClient.create_client(
   mcp_server_configs: [
     MCPClient.sse_config(
       base_url: 'http://localhost:8931/sse',
-      read_timeout: 30,  # Timeout in seconds
+      read_timeout: 30,  # Timeout in seconds for request fulfillment
+      ping: 10,          # Send ping after 10 seconds of inactivity
+                         # Connection closes automatically after inactivity (2.5x ping interval)
+      retries: 2         # Number of retry attempts on transient errors
     )
   ]
 )
@@ -262,6 +269,7 @@ Complete examples can be found in the `examples/` directory:
 - `ruby_openai_mcp.rb` - Integration with alexrudall/ruby-openai gem
 - `openai_ruby_mcp.rb` - Integration with official openai/openai-ruby gem
 - `ruby_anthropic_mcp.rb` - Integration with alexrudall/ruby-anthropic gem
+- `gemini_ai_mcp.rb` - Integration with Google Vertex AI and Gemini models
 - `mcp_sse_server_example.rb` - SSE transport with Playwright MCP
 
 ## MCP Server Compatibility
@@ -349,6 +357,11 @@ Special configuration options:
 The SSE client implementation provides these key features:
 
 - **Robust connection handling**: Properly manages HTTP/HTTPS connections with configurable timeouts and retries
+- **Advanced connection management**:
+  - **Inactivity tracking**: Monitors connection activity to detect idle connections
+  - **Automatic ping**: Sends ping requests after a configurable period of inactivity (default: 10 seconds)
+  - **Automatic disconnection**: Closes idle connections after inactivity (2.5× ping interval)
+  - **MCP compliant**: Any server communication resets the inactivity timer per specification
 - **Thread safety**: All operations are thread-safe using monitors and synchronized access
 - **Reliable error handling**: Comprehensive error handling for network issues, timeouts, and malformed responses
 - **JSON-RPC over SSE**: Full implementation of JSON-RPC 2.0 over SSE transport with initialize handshake
@@ -411,4 +424,4 @@ This gem is available as open source under the [MIT License](LICENSE).
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/simonx1/ruby-mcp-client.
+https://github.com/simonx1/ruby-mcp-client.

data/lib/mcp_client/client.rb

@@ -94,6 +94,12 @@ module MCPClient
       tools.map(&:to_anthropic_tool)
     end
 
+    def to_google_tools(tool_names: nil)
+      tools = list_tools
+      tools = tools.select { |t| tool_names.include?(t.name) } if tool_names
+      tools.map(&:to_google_tool)
+    end
+
     # Clean up all server connections
     def cleanup
       servers.each(&:cleanup)

data/lib/mcp_client/server_factory.rb

@@ -21,6 +21,7 @@ module MCPClient
           base_url: config[:base_url],
           headers: config[:headers] || {},
           read_timeout: config[:read_timeout] || 30,
+          ping: config[:ping] || 10,
           retries: config[:retries] || 0,
           retry_backoff: config[:retry_backoff] || 1,
           logger: config[:logger]

data/lib/mcp_client/server_sse.rb

@@ -11,15 +11,20 @@ module MCPClient
   # Implementation of MCP server that communicates via Server-Sent Events (SSE)
   # Useful for communicating with remote MCP servers over HTTP
   class ServerSSE < ServerBase
+    # Ratio of close_after timeout to ping interval
+    CLOSE_AFTER_PING_RATIO = 2.5
+
     attr_reader :base_url, :tools, :server_info, :capabilities
 
     # @param base_url [String] The base URL of the MCP server
     # @param headers [Hash] Additional headers to include in requests
     # @param read_timeout [Integer] Read timeout in seconds (default: 30)
+    # @param ping [Integer] Time in seconds after which to send ping if no activity (default: 10)
     # @param retries [Integer] number of retry attempts on transient errors
     # @param retry_backoff [Numeric] base delay in seconds for exponential backoff
     # @param logger [Logger, nil] optional logger
-    def initialize(base_url:, headers: {}, read_timeout: 30, retries: 0, retry_backoff: 1, logger: nil)
+    def initialize(base_url:, headers: {}, read_timeout: 30, ping: 10,
+                   retries: 0, retry_backoff: 1, logger: nil)
       super()
       @logger = logger || Logger.new($stdout, level: Logger::WARN)
       @logger.progname = self.class.name
@@ -36,6 +41,9 @@ module MCPClient
       # HTTP client is managed via Faraday
       @tools = nil
       @read_timeout = read_timeout
+      @ping_interval = ping
+      # Set close_after to a multiple of the ping interval
+      @close_after = (ping * CLOSE_AFTER_PING_RATIO).to_i
 
       # SSE-provided JSON-RPC endpoint path for POST requests
       @rpc_endpoint = nil
@@ -51,6 +59,10 @@ module MCPClient
       @auth_error = nil
       # Whether to use SSE transport; may disable if handshake fails
       @use_sse = true
+
+      # Time of last activity
+      @last_activity_time = Time.now
+      @activity_timer_thread = nil
     end
 
     # Stream tool call fallback for SSE transport (yields single result)
@@ -138,6 +150,7 @@ module MCPClient
         start_sse_thread
         effective_timeout = [@read_timeout || 30, 30].min
         wait_for_connection(timeout: effective_timeout)
+        start_activity_monitor
         true
       rescue MCPClient::Errors::ConnectionError => e
         cleanup
@@ -169,6 +182,13 @@ module MCPClient
         end
         @sse_thread = nil
 
+        begin
+          @activity_timer_thread&.kill
+        rescue StandardError
+          nil
+        end
+        @activity_timer_thread = nil
+
         if @http_client
           @http_client.finish if @http_client.started?
           @http_client = nil
@@ -227,8 +247,56 @@ module MCPClient
       raise MCPClient::Errors::TransportError, "Failed to send notification: #{e.message}"
     end
 
+    # Ping the server to keep the connection alive
+    # @return [Hash] the result of the ping request
+    def ping
+      rpc_request('ping')
+    end
+
     private
 
+    # Start the activity monitor thread
+    # This thread monitors connection activity and:
+    # 1. Sends a ping if there's no activity for @ping_interval seconds
+    # 2. Closes the connection if there's no activity for @close_after seconds
+    def start_activity_monitor
+      return if @activity_timer_thread&.alive?
+
+      @mutex.synchronize { @last_activity_time = Time.now }
+
+      @activity_timer_thread = Thread.new do
+        loop do
+          sleep 1 # Check every second
+
+          last_activity = nil
+          @mutex.synchronize { last_activity = @last_activity_time }
+
+          time_since_activity = Time.now - last_activity
+
+          if @close_after && time_since_activity >= @close_after
+            @logger.info("Closing connection due to inactivity (#{time_since_activity.round(1)}s)")
+            cleanup
+            break
+          elsif @ping_interval && time_since_activity >= @ping_interval
+            begin
+              @logger.debug("Sending ping after #{time_since_activity.round(1)}s of inactivity")
+              ping
+              @mutex.synchronize { @last_activity_time = Time.now }
+            rescue StandardError => e
+              @logger.error("Error sending ping: #{e.message}")
+            end
+          end
+        end
+      rescue StandardError => e
+        @logger.error("Activity monitor error: #{e.message}")
+      end
+    end
+
+    # Record activity to reset the inactivity timer
+    def record_activity
+      @mutex.synchronize { @last_activity_time = Time.now }
+    end
+
     # 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
@@ -368,6 +436,9 @@ module MCPClient
     def process_sse_chunk(chunk)
       @logger.debug("Processing SSE chunk: #{chunk.inspect}")
 
+      # Only record activity for real events
+      record_activity if chunk.include?('event:')
+
       # 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'))
@@ -619,6 +690,10 @@ module MCPClient
     # @return [Hash] the result of the request
     def send_jsonrpc_request(request)
       @logger.debug("Sending JSON-RPC request: #{request.to_json}")
+
+      # Record activity when sending a request
+      record_activity
+
       uri = URI.parse(@base_url)
       base = "#{uri.scheme}://#{uri.host}:#{uri.port}"
       rpc_ep = @mutex.synchronize { @rpc_endpoint }
@@ -643,6 +718,9 @@ module MCPClient
       end
       @logger.debug("Received JSON-RPC response: #{response.status} #{response.body}")
 
+      # Record activity when receiving a response
+      record_activity
+
       unless response.success?
         raise MCPClient::Errors::ServerError, "Server returned error: #{response.status} #{response.reason_phrase}"
       end
@@ -651,17 +729,32 @@ module MCPClient
         # Wait for result via SSE channel
         request_id = request[:id]
         start_time = Time.now
+        # Use the specified read_timeout for the overall operation
         timeout = @read_timeout || 10
+
+        # Check every 100ms for the result, with a total timeout from read_timeout
         loop do
           result = nil
           @mutex.synchronize do
             result = @sse_results.delete(request_id) if @sse_results.key?(request_id)
           end
-          return result if result
-          break if Time.now - start_time > timeout
 
+          if result
+            # Record activity when receiving a result
+            record_activity
+            return result
+          end
+
+          current_time = Time.now
+          time_elapsed = current_time - start_time
+
+          # If we've exceeded the timeout, raise an error
+          break if time_elapsed > timeout
+
+          # Sleep for a short time before checking again
           sleep 0.1
         end
+
         raise MCPClient::Errors::ToolCallError, "Timeout waiting for SSE result for request #{request_id}"
       else
         begin

data/lib/mcp_client/tool.rb

@@ -46,5 +46,33 @@ module MCPClient
         input_schema: @schema
       }
     end
+
+    def to_google_tool
+      {
+        name: @name,
+        description: @description,
+        parameters: cleaned_schema(@schema)
+      }
+    end
+
+    private
+
+    # Recursively remove "$schema" keys that are not accepted by Vertex AI
+    # @param obj [Object] schema element (Hash/Array/other)
+    # @return [Object] cleaned schema without "$schema" keys
+    def cleaned_schema(obj)
+      case obj
+      when Hash
+        obj.each_with_object({}) do |(k, v), h|
+          next if k == '$schema'
+
+          h[k] = cleaned_schema(v)
+        end
+      when Array
+        obj.map { |v| cleaned_schema(v) }
+      else
+        obj
+      end
+    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.2'
+  VERSION = '0.5.3'
 end

data/lib/mcp_client.rb

@@ -58,15 +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 ping [Integer] time in seconds after which to send ping if no activity (default: 10)
   # @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, retries: 0, retry_backoff: 1)
+  def self.sse_config(base_url:, headers: {}, read_timeout: 30, ping: 10, retries: 0, retry_backoff: 1)
     {
       type: 'sse',
       base_url: base_url,
       headers: headers,
       read_timeout: read_timeout,
+      ping: ping,
       retries: retries,
       retry_backoff: retry_backoff
     }

metadata

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