shared_tools 0.4.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77d4fd4712e3a0eff81653da54bafa994746c6334780e95862379a943c3b5274
-  data.tar.gz: fd504802d298371efe604e341e9a339fef42acecf2ff47148d70007efe901c44
+  metadata.gz: 679fe640e745e716a1ec2c9cb77fd9af47b67b09ddd5caba23ef9b6fbbf50d24
+  data.tar.gz: afa308531e5afc205b244771db0ed2e8965e5532d5f642d81c3284819db6f7b6
 SHA512:
-  metadata.gz: f14ebee5d9ceb6fadfafa19af5bfc18c0ece33ba4d2d6894f2c4192e5ffe9abf41e8f3f4f8a109f2ab646b0ac076b9b3f530839af1dd4f979a7ba3c88b19cab0
-  data.tar.gz: '0428dda46694b2f0eebb6112884a45f1d33e3a43dd23938598c1b4e3ca9163446b4033c8f1273c6f782047dc4d3c62d6d4b3ffdaff7173cacbfbe4f212a194dd'
+  metadata.gz: 87264d8b31d6b016e56ac361fa528a73071163f4dfaa4d562e877e20b7d011aa85a0de033212aa326fe9e8983940893d046237eab043c5ee6f61306dc126c21b
+  data.tar.gz: eee3b6364a669539ff7d1ffb290e1255416c0a20f32f68873a4d69061dcf41e5675a23b2ecb3fcacaf7714f6ad0b69d726cf3577642bceef611895574870d44c

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## Unreleased
+
+### [0.4.4] - 2026-06-06
+
+#### Tools
+- Added `SearchCodebaseTool` (`tools/search_codebase_tool.rb`) — read-only codebase search using ripgrep (`rg`) with grep fallback; supports `path`, `extension`, and `max_results` parameters; returns matches with file path and line number; no authorization prompt required
+- Enhanced `ShellEvalTool`: added optional `workdir` parameter to set the working directory for command execution; validates the directory exists before running
+- Enhanced `ShellEvalTool`: output is now truncated at 5000 bytes (stdout) and 2000 bytes (stderr) to prevent oversized tool responses; truncated output is marked with `[truncated]`
+- Moved `require "open3"` to the top of `ShellEvalTool` instead of inline inside `execute`
+
+#### Tests
+- Added `test/shared_tools/tools/search_codebase_tool_test.rb` — 16 tests covering search, extension filtering, `max_results` capping, truncation flag, error cases, and tool-key reporting
+- Added 4 tests to `test/shared_tools/tools/eval/shell_eval_tool_test.rb` covering `workdir` execution, missing-directory error, stdout truncation, and non-truncation of short output
+
+### [0.4.2] - 2026-03-27
+
+#### MCP Clients
+- Added Playwright MCP client (`mcp/playwright_client.rb`) — browser automation via the official `@playwright/mcp` package (npx auto-download, no pre-installation required)
+- Added `mcp/tool_schema_patch.rb` — strips `$schema` from MCP tool input schemas before API serialization; fixes `BadRequestError` from Claude's API when MCP servers annotate schemas with JSON Schema Draft 2020-12 meta-fields
+- Added demo script: `examples/mcp/playwright_demo.rb`
+
 ## Released
 
 ### [0.4.1] - 2026-03-26

data/README.md

@@ -437,6 +437,7 @@ SharedTools bundles [Model Context Protocol](https://modelcontextprotocol.io) cl
 | `require 'shared_tools/mcp/sequential_thinking_client'` | Chain-of-thought reasoning |
 | `require 'shared_tools/mcp/chart_client'` | Chart and visualisation generation |
 | `require 'shared_tools/mcp/brave_search_client'` | Web and news search (`BRAVE_API_KEY`) |
+| `require 'shared_tools/mcp/playwright_client'` | Browser automation: navigate, click, fill, screenshot, extract |
 
 ```ruby
 # Load all available clients at once (skips any whose env vars are missing)
@@ -523,6 +524,7 @@ bundle exec ruby -I examples examples/doc_tool_demo.rb
 | `mcp/sequential_thinking_demo.rb` | Chain-of-thought reasoning |
 | `mcp/chart_demo.rb` | Chart generation |
 | `mcp/brave_search_demo.rb` | Brave web search |
+| `mcp/playwright_demo.rb` | Browser automation via Playwright |
 | `notification_tool_demo.rb` | Desktop notifications, alerts, TTS |
 | `system_info_tool_demo.rb` | System info |
 | `weather_tool_demo.rb` | Weather + local forecast |

data/lib/shared_tools/mcp/playwright_client.rb

@@ -0,0 +1,34 @@
+# shared_tools/mcp/playwright_client.rb
+#
+# Playwright MCP Server Client — npx auto-download (no pre-installation required)
+#
+# Provides browser automation via Playwright: navigate pages, click elements,
+# fill forms, take screenshots, extract text/HTML, and interact with web apps.
+#
+# Uses the official @playwright/mcp package from the Playwright team.
+#
+# Prerequisites:
+#   - Node.js and npx (https://nodejs.org)
+#   The @playwright/mcp package is downloaded automatically on first use via `npx -y`.
+#
+# Configuration:
+#   No environment variables required.
+#
+# Usage:
+#   require 'shared_tools/mcp/playwright_client'
+#   client = RubyLLM::MCP.clients["playwright"]
+#   chat = RubyLLM.chat.with_tools(*client.tools)
+#
+# Compatible with ruby_llm-mcp >= 0.7.0
+
+require "ruby_llm/mcp"
+
+RubyLLM::MCP.add_client(
+  name: "playwright",
+  transport_type: :stdio,
+  config: {
+    command: "npx",
+    args:    ["-y", "@playwright/mcp"],
+    env:     {},
+  },
+)

data/lib/shared_tools/tools/calculator_tool.rb

@@ -1,12 +1,22 @@
 # calculator_tool.rb - Safe mathematical calculator
 require 'ruby_llm/tool'
-require 'dentaku'
+
+DENTAKU_AVAILABLE = begin
+  require 'dentaku'
+  true
+rescue LoadError, Gem::LoadError
+  false
+end
 
 module SharedTools
   module Tools
     class CalculatorTool < RubyLLM::Tool
       def self.name = 'calculator'
 
+      def available?
+        DENTAKU_AVAILABLE
+      end
+
       description <<~'DESCRIPTION'
         Perform advanced mathematical calculations with comprehensive error handling and validation.
         This tool supports basic arithmetic operations, parentheses, and common mathematical functions.

data/lib/shared_tools/tools/database_query_tool.rb

@@ -1,12 +1,22 @@
 # database_query_tool.rb - Safe database query execution
 require 'ruby_llm/tool'
-require 'sequel'
+
+SEQUEL_AVAILABLE = begin
+  require 'sequel'
+  true
+rescue LoadError, Gem::LoadError
+  false
+end
 
 module SharedTools
   module Tools
     class DatabaseQueryTool < RubyLLM::Tool
       def self.name = 'database_query'
 
+      def available?
+        SEQUEL_AVAILABLE
+      end
+
       description <<~'DESCRIPTION'
         Execute safe, read-only database queries with automatic connection management and security controls.
         This tool is designed for secure data retrieval operations only, restricting access to SELECT statements

data/lib/shared_tools/tools/eval/shell_eval_tool.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "open3"
 
 module SharedTools
   module Tools
@@ -7,13 +8,18 @@ module SharedTools
       # @example
       #   tool = SharedTools::Tools::Eval::ShellEvalTool.new
       #   tool.execute(command: "ls -la")
+      #   tool.execute(command: "ls -la", workdir: "/tmp")
       class ShellEvalTool < ::RubyLLM::Tool
+        STDOUT_MAX = 5000
+        STDERR_MAX = 2000
+
         def self.name = 'eval_shell'
 
         description "Execute a shell command safely and return the result."
 
         params do
           string :command, description: "The shell command to execute"
+          string :workdir, description: "Working directory for the command (default: current directory)", required: false
         end
 
         # @param logger [Logger] optional logger
@@ -22,9 +28,10 @@ module SharedTools
         end
 
         # @param command [String] shell command to execute
+        # @param workdir [String, nil] working directory for the command
         #
         # @return [Hash] execution result
-        def execute(command:)
+        def execute(command:, workdir: nil)
           @logger.info("Requesting permission to execute command: '#{command}'")
 
           if command.strip.empty?
@@ -33,7 +40,12 @@ module SharedTools
             return { error: error_msg }
           end
 
-          # Show user the command and ask for confirmation
+          if workdir
+            unless File.directory?(workdir)
+              return { error: "Working directory not found: #{workdir}" }
+            end
+          end
+
           allowed = SharedTools.execute?(tool: self.class.to_s, stuff: command)
 
           unless allowed
@@ -43,9 +55,11 @@ module SharedTools
 
           @logger.info("Executing command: '#{command}'")
 
-          # Use Open3 for safer command execution with proper error handling
-          require "open3"
-          stdout, stderr, status = Open3.capture3(command)
+          opts = workdir ? { chdir: workdir } : {}
+          stdout, stderr, status = Open3.capture3(command, **opts)
+
+          stdout = truncate(stdout, STDOUT_MAX)
+          stderr = truncate(stderr, STDERR_MAX)
 
           if status.success?
             @logger.debug("Command execution completed successfully with #{stdout.bytesize} bytes of output")
@@ -58,6 +72,13 @@ module SharedTools
           @logger.error("Command execution failed: #{e.message}")
           { error: e.message }
         end
+
+        private
+
+        def truncate(str, max)
+          return str if str.length <= max
+          str.slice(0, max) + "\n[truncated]"
+        end
       end
     end
   end

data/lib/shared_tools/tools/search_codebase_tool.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module SharedTools
+  module Tools
+    # Search for a term across files using ripgrep (rg) with grep as fallback.
+    # Read-only — no authorization prompt required.
+    #
+    # @example
+    #   tool = SharedTools::Tools::SearchCodebaseTool.new
+    #   tool.execute(term: "def execute")
+    #   tool.execute(term: "RubyLLM", extension: "rb", max_results: 20)
+    class SearchCodebaseTool < ::RubyLLM::Tool
+      MAX_RESULTS_CAP = 500
+
+      def self.name = 'search_codebase'
+
+      description "Search for a term or pattern across files. Uses ripgrep (rg) when available, falls back to grep. Returns matching lines with file path and line number."
+
+      params do
+        string  :term,        description: "The search term or regex pattern to find"
+        string  :path,        description: "Directory to search in (default: current directory)", required: false
+        string  :extension,   description: "File extension to restrict the search to, without the dot (e.g. 'rb', 'js')", required: false
+        integer :max_results, description: "Maximum number of matching lines to return (default: 50, max: 500)", required: false
+      end
+
+      def initialize(logger: nil)
+        @logger = logger || RubyLLM.logger
+      end
+
+      def execute(term:, path: ".", extension: nil, max_results: 50)
+        @logger.info("SearchCodebaseTool#execute term=#{term.inspect} path=#{path} extension=#{extension.inspect}")
+
+        return { error: "Search term cannot be empty" } if term.strip.empty?
+
+        max_results = [[max_results.to_i, 1].max, MAX_RESULTS_CAP].min
+        search_path = File.expand_path(path)
+
+        return { error: "Path not found: #{path}" } unless File.exist?(search_path)
+
+        stdout, _stderr, _status = run_search(term: term, path: search_path, extension: extension)
+
+        all_lines  = stdout.lines.map(&:chomp).reject(&:empty?)
+        matches    = all_lines.first(max_results)
+        truncated  = all_lines.size > max_results
+
+        {
+          matches:   matches,
+          count:     matches.size,
+          truncated: truncated,
+          tool:      ripgrep_available? ? "rg" : "grep"
+        }
+      rescue => e
+        @logger.error("SearchCodebaseTool error: #{e.message}")
+        { error: e.message }
+      end
+
+      private
+
+      def run_search(term:, path:, extension:)
+        if ripgrep_available?
+          run_ripgrep(term: term, path: path, extension: extension)
+        else
+          run_grep(term: term, path: path, extension: extension)
+        end
+      end
+
+      def run_ripgrep(term:, path:, extension:)
+        args = ["rg", "--no-heading", "-n"]
+        args += ["-g", "*.#{extension}"] if extension
+        args << term
+        args << path
+        Open3.capture3(*args)
+      end
+
+      def run_grep(term:, path:, extension:)
+        args = ["grep", "-r", "-n"]
+        args += ["--include=*.#{extension}"] if extension
+        args << term
+        args << path
+        Open3.capture3(*args)
+      end
+
+      def ripgrep_available?
+        return @ripgrep_available unless @ripgrep_available.nil?
+        @ripgrep_available = system("which", "rg", out: File::NULL, err: File::NULL)
+      end
+    end
+  end
+end

data/lib/shared_tools/tools/weather_tool.rb

@@ -1,12 +1,22 @@
 # weather_tool.rb - API integration example
 require 'ruby_llm/tool'
-require 'openweathermap'
+
+OPENWEATHERMAP_AVAILABLE = begin
+  require 'openweathermap'
+  true
+rescue LoadError, Gem::LoadError
+  false
+end
 
 module SharedTools
   module Tools
     class WeatherTool < RubyLLM::Tool
       def self.name = 'weather_tool'
 
+      def available?
+        OPENWEATHERMAP_AVAILABLE
+      end
+
       description <<~'DESCRIPTION'
         Retrieve comprehensive current weather information for any city worldwide using the OpenWeatherMap API.
         This tool provides real-time weather data including temperature, atmospheric conditions, humidity,

data/lib/shared_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SharedTools
-  VERSION = "0.4.1"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shared_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.4
 platform: ruby
 authors:
 - Dewayne VanHoozer
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: dentaku
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +86,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -86,7 +100,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -100,7 +114,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -297,6 +311,7 @@ files:
 - lib/shared_tools/mcp/hugging_face_client.rb
 - lib/shared_tools/mcp/memory_client.rb
 - lib/shared_tools/mcp/notion_client.rb
+- lib/shared_tools/mcp/playwright_client.rb
 - lib/shared_tools/mcp/sequential_thinking_client.rb
 - lib/shared_tools/mcp/slack_client.rb
 - lib/shared_tools/mcp/streamable_http_patch.rb
@@ -384,6 +399,7 @@ files:
 - lib/shared_tools/tools/notification/mac_driver.rb
 - lib/shared_tools/tools/notification/null_driver.rb
 - lib/shared_tools/tools/notification_tool.rb
+- lib/shared_tools/tools/search_codebase_tool.rb
 - lib/shared_tools/tools/secure_tool_template.rb
 - lib/shared_tools/tools/system_info_tool.rb
 - lib/shared_tools/tools/version.rb
@@ -414,7 +430,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.13
 specification_version: 4
 summary: Shared utilities and AI tools for Ruby applications with configurable logging
 test_files: []