update doc

app.py

@@ -11,7 +11,7 @@ from tools.web_search import DuckDuckGoSearchTool
 from tools.visit_webpage import VisitWebpageTool
 from tools.get_timezone import get_current_time_in_timezone
 from tools.calculate import calculator
-from tools.analyze_repo import GitHubCodeQualityTool
+from tools.analyze_repo import GitHubAnalyzerTool
 
 from Gradio_UI import GradioUI
 
@@ -29,7 +29,7 @@ def my_custom_tool(arg1:str, arg2:int)-> str: #it's import to specify the return
 final_answer = FinalAnswerTool()
 web_search = DuckDuckGoSearchTool()
 visit_webpage = VisitWebpageTool()
-analyze_code_quality = GitHubCodeQualityTool()
+analyze_github_repository = GitHubAnalyzerTool()
 
 # If the agent does not answer, the model is overloaded, please use another model or the following Hugging Face Endpoint that also contains qwen2.5 coder:
 # model_id='https://pflgm2locj2t89co.us-east-1.aws.endpoints.huggingface.cloud' 
@@ -57,7 +57,7 @@ agent = CodeAgent(
         visit_webpage,
         get_current_time_in_timezone,
         calculator,
-        analyze_code_quality,
+        analyze_github_repository,
     ], ## add your tools here (don't remove final answer)
     max_steps=6,
     verbosity_level=1,

tools/analyze_repo.py

@@ -2,9 +2,9 @@ from typing import Any, Dict
 import requests
 from smolagents.tools import Tool
 
-class GitHubCodeQualityTool(Tool):
-    name = "github_code_quality"
-    description = "Analyzes the code quality of a public GitHub repository."
+class GitHubAnalyzerTool(Tool):
+    name = "analyze_github_repository"
+    description = "Analyzes statistics such as issues, pull_requests, contributors, stars and forks of a public GitHub repository and return a synthesis in markdown string with the results."
     inputs = {
         'github_url': {'type': 'string', 'description': 'The URL of the public GitHub repository to analyze.'}
     }
@@ -15,13 +15,11 @@ class GitHubCodeQualityTool(Tool):
 
     def forward(self, github_url: str) -> str:
         """
-        Analyzes the code quality of a public GitHub repository.
-
+        Analyzes statistics such as issues, pull_requests, contributors, stars and forks of a public GitHub repository and return a synthesis in markdown string with the results.
         Args:
             github_url: The URL of the public GitHub repository to analyze.
-
         Returns:
-            A string containing the code quality analysis results in Markdown format.
+            A synthesis of repository statistics in markdown string with the results.
         """
         if not self.validate_github_url(github_url):
             return "Please provide a valid GitHub repository URL."