Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
docs: add gh_token documentation to GithubSearchTool
theCyberTech58af5c08f9f3
diff --git a/docs/tools/githubsearchtool.mdx b/docs/tools/githubsearchtool.mdxindex 6fd0e686a..80b363a3c 100644--- a/docs/tools/githubsearchtool.mdx+++ b/docs/tools/githubsearchtool.mdx@@ -34,6 +34,7 @@ from crewai_tools import GithubSearchTool# Initialize the tool for semantic searches within a specific GitHub repositorytool = GithubSearchTool(github_repo='https://github.com/example/repo',+ gh_token='your_github_personal_access_token',content_types=['code', 'issue'] # Options: code, repo, pr, issue)@@ -41,6 +42,7 @@ tool = GithubSearchTool(# Initialize the tool for semantic searches within a specific GitHub repository, so the agent can search any repository if it learns about during its executiontool = GithubSearchTool(+ gh_token='your_github_personal_access_token',content_types=['code', 'issue'] # Options: code, repo, pr, issue)```@@ -48,6 +50,7 @@ tool = GithubSearchTool(## Arguments- `github_repo` : The URL of the GitHub repository where the search will be conducted. This is a mandatory field and specifies the target repository for your search.+- `gh_token` : Your GitHub Personal Access Token (PAT) required for authentication. You can create one in your GitHub account settings under Developer Settings > Personal Access Tokens.- `content_types` : Specifies the types of content to include in your search. You must provide a list of content types from the following options: `code` for searching within the code,`repo` for searching within the repository's general information, `pr` for searching within pull requests, and `issue` for searching within issues.This field is mandatory and allows tailoring the search to specific content types within the GitHub repository.@@ -77,5 +80,4 @@ tool = GithubSearchTool(),),)-)-```\ No newline at end of file+)\ No newline at end of file