feat: add method documentation to all tools using ToolMetadata

Author: nachoal

lib/tools/calculate_tool.rb

@@ -1,6 +1,11 @@
 require_relative "tool"
+require_relative "tool_metadata"
 
 class CalculateTool < Tool
+  extend ToolMetadata
+
+  describe :call, "Evaluates mathematical expressions with support for basic operators (+, -, *, /, %, **) and parentheses."
+
   def initialize
     super("calculate")
   end

lib/tools/google_search_tool.rb

@@ -1,8 +1,13 @@
 require "http"
 require "json"
 require_relative "tool"
+require_relative "tool_metadata"
 
 class GoogleSearchTool < Tool
+  extend ToolMetadata
+
+  describe :call, "Performs a Google search using Custom Search API and returns detailed results including titles, URLs, descriptions, and metadata for up to 10 results."
+
   def initialize
     super("google_search")
     @api_key = ENV["GOOGLE_SEARCH_API_KEY"]

lib/tools/tool.rb

@@ -17,7 +17,13 @@
 #       # Return a string result
 #     end
 #   end
+require_relative "tool_metadata"
+
 class Tool
+  extend ToolMetadata
+
+  describe :call, "Base method that all tools must implement to process input and return a result. This method should be overridden by subclasses."
+
   # The name of the tool, used to identify it in prompts and commands
   attr_reader :name
 

lib/tools/tool_registry.rb

@@ -14,9 +14,14 @@
 require "singleton"
 require "pathname"
 require_relative "tool"
+require_relative "tool_metadata"
 
 class ToolRegistry
   include Singleton
+  extend ToolMetadata
+
+  describe :fetch, "Retrieves a tool instance by its name, raising an error if the tool doesn't exist."
+  describe :tools, "Returns a hash of all registered tools, mapping tool names to their instances."
 
   # Initialize the registry and load all available tools
   def initialize

lib/tools/wikipedia_tool.rb

@@ -1,8 +1,13 @@
 require "http"
 require "json"
 require_relative "tool"
+require_relative "tool_metadata"
 
 class WikipediaTool < Tool
+  extend ToolMetadata
+
+  describe :call, "Searches Wikipedia for the given query and returns the snippet of the most relevant article match."
+
   def initialize
     super("wikipedia")
   end