docs: Docs updates (#3459)

* docs(cli): document device-code login and config reset guidance; renumber sections

* docs(cli): fix duplicate numbering (renumber Login/API Keys/Configuration sections)

* docs: Fix webhook documentation to include meta dict in all webhook payloads

- Add note explaining that meta objects from kickoff requests are included in all webhook payloads
- Update webhook examples to show proper payload structure including meta field
- Fix webhook examples to match actual API implementation
- Apply changes to English, Korean, and Portuguese documentation

Resolves the documentation gap where meta dict passing to webhooks was not documented despite being implemented in the API.

* WIP: CrewAI docs theme, changelog, GEO, localization

* docs(cli): fix merge markers; ensure mode: "wide"; convert ASCII tables to Markdown (en/pt-BR/ko)

* docs: add group icons across locales; split Automation/Integrations; update tools overviews and links
This commit is contained in:
Tony Kipkemboi
2025-09-05 17:40:11 -04:00
committed by GitHub
parent 99b79ab20d
commit 1a1bb0ca3d
557 changed files with 6448 additions and 86 deletions

View File

@@ -2,6 +2,7 @@
title: AI Mind Tool
description: The `AIMindTool` is designed to query data sources in natural language.
icon: brain
mode: "wide"
---
# `AIMindTool`

View File

@@ -2,6 +2,7 @@
title: Code Interpreter
description: The `CodeInterpreterTool` is a powerful tool designed for executing Python 3 code within a secure, isolated environment.
icon: code-simple
mode: "wide"
---
# `CodeInterpreterTool`

View File

@@ -2,6 +2,7 @@
title: DALL-E Tool
description: The `DallETool` is a powerful tool designed for generating images from textual descriptions.
icon: image
mode: "wide"
---
# `DallETool`

View File

@@ -2,6 +2,7 @@
title: LangChain Tool
description: The `LangChainTool` is a wrapper for LangChain tools and query engines.
icon: link
mode: "wide"
---
## `LangChainTool`

View File

@@ -2,6 +2,7 @@
title: LlamaIndex Tool
description: The `LlamaIndexTool` is a wrapper for LlamaIndex tools and query engines.
icon: address-book
mode: "wide"
---
# `LlamaIndexTool`

View File

@@ -2,6 +2,7 @@
title: "Overview"
description: "Leverage AI services, generate images, process vision, and build intelligent systems"
icon: "face-smile"
mode: "wide"
---
These tools integrate with AI and machine learning services to enhance your agents with advanced capabilities like image generation, vision processing, and intelligent code execution.

View File

@@ -2,6 +2,7 @@
title: RAG Tool
description: The `RagTool` is a dynamic knowledge base tool for answering questions using Retrieval-Augmented Generation.
icon: vector-square
mode: "wide"
---
# `RagTool`

View File

@@ -2,6 +2,7 @@
title: Vision Tool
description: The `VisionTool` is designed to extract text from images.
icon: eye
mode: "wide"
---
# `VisionTool`

View File

@@ -3,6 +3,7 @@ title: Apify Actors
description: "`ApifyActorsTool` lets you call Apify Actors to provide your CrewAI workflows with web scraping, crawling, data extraction, and web automation capabilities."
# hack to use custom Apify icon
icon: "); -webkit-mask-image: url('https://upload.wikimedia.org/wikipedia/commons/a/ae/Apify.svg');/*"
mode: "wide"
---
# `ApifyActorsTool`

View File

@@ -2,6 +2,7 @@
title: Composio Tool
description: Composio provides 250+ production-ready tools for AI agents with flexible authentication management.
icon: gear-code
mode: "wide"
---
# `ComposioToolSet`

View File

@@ -2,6 +2,7 @@
title: MultiOn Tool
description: The `MultiOnTool` empowers CrewAI agents with the capability to navigate and interact with the web through natural language instructions.
icon: globe
mode: "wide"
---
## Overview

View File

@@ -2,6 +2,7 @@
title: "Overview"
description: "Automate workflows and integrate with external platforms and services"
icon: "face-smile"
mode: "wide"
---
These tools enable your agents to automate workflows, integrate with external platforms, and connect with various third-party services for enhanced functionality.

View File

@@ -2,6 +2,7 @@
title: Zapier Actions Tool
description: The `ZapierActionsAdapter` exposes Zapier actions as CrewAI tools for automation.
icon: bolt
mode: "wide"
---
# `ZapierActionsAdapter`

View File

@@ -2,6 +2,7 @@
title: 'Bedrock Knowledge Base Retriever'
description: 'Retrieve information from Amazon Bedrock Knowledge Bases using natural language queries'
icon: aws
mode: "wide"
---
# `BedrockKBRetrieverTool`

View File

@@ -2,6 +2,7 @@
title: "Overview"
description: "Interact with cloud services, storage systems, and cloud-based AI platforms"
icon: "face-smile"
mode: "wide"
---
These tools enable your agents to interact with cloud services, access cloud storage, and leverage cloud-based AI platforms for scalable operations.

View File

@@ -2,6 +2,7 @@
title: S3 Reader Tool
description: The `S3ReaderTool` enables CrewAI agents to read files from Amazon S3 buckets.
icon: aws
mode: "wide"
---
# `S3ReaderTool`

View File

@@ -2,6 +2,7 @@
title: S3 Writer Tool
description: The `S3WriterTool` enables CrewAI agents to write content to files in Amazon S3 buckets.
icon: aws
mode: "wide"
---
# `S3WriterTool`

View File

@@ -2,6 +2,7 @@
title: MongoDB Vector Search Tool
description: The `MongoDBVectorSearchTool` performs vector search on MongoDB Atlas with optional indexing helpers.
icon: "leaf"
mode: "wide"
---
# `MongoDBVectorSearchTool`

View File

@@ -2,6 +2,7 @@
title: MySQL RAG Search
description: The `MySQLSearchTool` is designed to search MySQL databases and return the most relevant results.
icon: database
mode: "wide"
---
## Overview

View File

@@ -2,6 +2,7 @@
title: NL2SQL Tool
description: The `NL2SQLTool` is designed to convert natural language to SQL queries.
icon: language
mode: "wide"
---
## Overview

View File

@@ -2,6 +2,7 @@
title: "Overview"
description: "Connect to databases, vector stores, and data warehouses for comprehensive data access"
icon: "face-smile"
mode: "wide"
---
These tools enable your agents to interact with various database systems, from traditional SQL databases to modern vector stores and data warehouses.

View File

@@ -2,6 +2,7 @@
title: PG RAG Search
description: The `PGSearchTool` is designed to search PostgreSQL databases and return the most relevant results.
icon: elephant
mode: "wide"
---
## Overview

View File

@@ -2,6 +2,7 @@
title: 'Qdrant Vector Search Tool'
description: 'Semantic search capabilities for CrewAI agents using Qdrant vector database'
icon: vector-square
mode: "wide"
---
## Overview

View File

@@ -2,6 +2,7 @@
title: SingleStore Search Tool
description: The `SingleStoreSearchTool` safely executes SELECT/SHOW queries on SingleStore with pooling.
icon: circle
mode: "wide"
---
# `SingleStoreSearchTool`

View File

@@ -2,6 +2,7 @@
title: Snowflake Search Tool
description: The `SnowflakeSearchTool` enables CrewAI agents to execute SQL queries and perform semantic search on Snowflake data warehouses.
icon: snowflake
mode: "wide"
---
# `SnowflakeSearchTool`

View File

@@ -2,6 +2,7 @@
title: Weaviate Vector Search
description: The `WeaviateVectorSearchTool` is designed to search a Weaviate vector database for semantically similar documents using hybrid search.
icon: network-wired
mode: "wide"
---
## Overview

View File

@@ -2,6 +2,7 @@
title: CSV RAG Search
description: The `CSVSearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within a CSV file's content.
icon: file-csv
mode: "wide"
---
# `CSVSearchTool`

View File

@@ -2,6 +2,7 @@
title: Directory Read
description: The `DirectoryReadTool` is a powerful utility designed to provide a comprehensive listing of directory contents.
icon: folder-tree
mode: "wide"
---
# `DirectoryReadTool`

View File

@@ -2,6 +2,7 @@
title: Directory RAG Search
description: The `DirectorySearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within a directory's content.
icon: address-book
mode: "wide"
---
# `DirectorySearchTool`

View File

@@ -2,6 +2,7 @@
title: DOCX RAG Search
description: The `DOCXSearchTool` is a RAG tool designed for semantic searching within DOCX documents.
icon: file-word
mode: "wide"
---
# `DOCXSearchTool`

View File

@@ -2,6 +2,7 @@
title: File Read
description: The `FileReadTool` is designed to read files from the local file system.
icon: folders
mode: "wide"
---
## Overview

View File

@@ -2,6 +2,7 @@
title: File Write
description: The `FileWriterTool` is designed to write content to files.
icon: file-pen
mode: "wide"
---
# `FileWriterTool`

View File

@@ -2,6 +2,7 @@
title: JSON RAG Search
description: The `JSONSearchTool` is designed to search JSON files and return the most relevant results.
icon: file-code
mode: "wide"
---
# `JSONSearchTool`

View File

@@ -2,6 +2,7 @@
title: MDX RAG Search
description: The `MDXSearchTool` is designed to search MDX files and return the most relevant results.
icon: markdown
mode: "wide"
---
# `MDXSearchTool`

View File

@@ -2,6 +2,7 @@
title: OCR Tool
description: The `OCRTool` extracts text from local images or image URLs using an LLM with vision.
icon: image
mode: "wide"
---
# `OCRTool`

View File

@@ -2,6 +2,7 @@
title: "Overview"
description: "Read, write, and search through various file formats with CrewAI's document processing tools"
icon: "face-smile"
mode: "wide"
---
These tools enable your agents to work with various file formats and document types. From reading PDFs to processing JSON data, these tools handle all your document processing needs.

View File

@@ -2,6 +2,7 @@
title: PDF Text Writing Tool
description: The `PDFTextWritingTool` writes text to specific positions in a PDF, supporting custom fonts.
icon: file-pdf
mode: "wide"
---
# `PDFTextWritingTool`

View File

@@ -2,6 +2,7 @@
title: PDF RAG Search
description: The `PDFSearchTool` is designed to search PDF files and return the most relevant results.
icon: file-pdf
mode: "wide"
---
# `PDFSearchTool`

View File

@@ -2,6 +2,7 @@
title: TXT RAG Search
description: The `TXTSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a text file.
icon: file-lines
mode: "wide"
---
## Overview

View File

@@ -2,6 +2,7 @@
title: XML RAG Search
description: The `XMLSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a XML file.
icon: file-xml
mode: "wide"
---
# `XMLSearchTool`

View File

@@ -2,6 +2,7 @@
title: Bedrock Invoke Agent Tool
description: Enables CrewAI agents to invoke Amazon Bedrock Agents and leverage their capabilities within your workflows
icon: aws
mode: "wide"
---
# `BedrockInvokeAgentTool`

View File

@@ -2,6 +2,7 @@
title: "Tools Overview"
description: "Discover CrewAI's extensive library of 40+ tools to supercharge your AI agents"
icon: "toolbox"
mode: "wide"
---
CrewAI provides an extensive library of pre-built tools to enhance your agents' capabilities. From file processing to web scraping, database queries to AI services - we've got you covered.
@@ -11,7 +12,7 @@ CrewAI provides an extensive library of pre-built tools to enhance your agents'
<CardGroup cols={2}>
<Card
title="File & Document"
icon="file-check"
icon="folder-open"
href="/en/tools/file-document/overview"
color="#3B82F6"
>
@@ -64,12 +65,21 @@ CrewAI provides an extensive library of pre-built tools to enhance your agents'
</Card>
<Card
title="Automation & Integration"
title="Automation"
icon="bolt"
href="/en/tools/automation/overview"
color="#84CC16"
>
Automate workflows with Apify, Composio, and other integration platforms to connect your agents with external services.
Automate workflows with Apify, Composio, and other platforms to connect your agents with external services.
</Card>
<Card
title="Integrations"
icon="plug"
href="/en/tools/tool-integrations/overview"
color="#0891B2"
>
Integrate CrewAI with external systems like Amazon Bedrock and the CrewAI Automation toolkit.
</Card>
</CardGroup>

View File

@@ -2,6 +2,7 @@
title: Arxiv Paper Tool
description: The `ArxivPaperTool` searches arXiv for papers matching a query and optionally downloads PDFs.
icon: box-archive
mode: "wide"
---
# `ArxivPaperTool`

View File

@@ -2,6 +2,7 @@
title: Brave Search
description: The `BraveSearchTool` is designed to search the internet using the Brave Search API.
icon: searchengin
mode: "wide"
---
# `BraveSearchTool`

View File

@@ -2,6 +2,7 @@
title: Code Docs RAG Search
description: The `CodeDocsSearchTool` is a powerful RAG (Retrieval-Augmented Generation) tool designed for semantic searches within code documentation.
icon: code
mode: "wide"
---
# `CodeDocsSearchTool`

View File

@@ -2,6 +2,7 @@
title: Databricks SQL Query Tool
description: The `DatabricksQueryTool` executes SQL queries against Databricks workspace tables.
icon: trowel-bricks
mode: "wide"
---
# `DatabricksQueryTool`

View File

@@ -2,6 +2,7 @@
title: EXA Search Web Loader
description: The `EXASearchTool` is designed to perform a semantic search for a specified query from a text's content across the internet.
icon: globe-pointer
mode: "wide"
---
# `EXASearchTool`

View File

@@ -2,6 +2,7 @@
title: Github Search
description: The `GithubSearchTool` is designed to search websites and convert them into clean markdown or structured data.
icon: github
mode: "wide"
---
# `GithubSearchTool`

View File

@@ -2,6 +2,7 @@
title: Linkup Search Tool
description: The `LinkupSearchTool` enables querying the Linkup API for contextual information.
icon: link
mode: "wide"
---
# `LinkupSearchTool`

View File

@@ -2,6 +2,7 @@
title: "Overview"
description: "Perform web searches, find repositories, and research information across the internet"
icon: "face-smile"
mode: "wide"
---
These tools enable your agents to search the web, research topics, and find information across various platforms including search engines, GitHub, and YouTube.

View File

@@ -2,6 +2,7 @@
title: SerpApi Google Search Tool
description: The `SerpApiGoogleSearchTool` performs Google searches using the SerpApi service.
icon: google
mode: "wide"
---
# `SerpApiGoogleSearchTool`

View File

@@ -2,6 +2,7 @@
title: SerpApi Google Shopping Tool
description: The `SerpApiGoogleShoppingTool` searches Google Shopping results using SerpApi.
icon: cart-shopping
mode: "wide"
---
# `SerpApiGoogleShoppingTool`

View File

@@ -2,6 +2,7 @@
title: Google Serper Search
description: The `SerperDevTool` is designed to search the internet and return the most relevant results.
icon: google
mode: "wide"
---
# `SerperDevTool`

View File

@@ -2,6 +2,7 @@
title: "Tavily Extractor Tool"
description: "Extract structured content from web pages using the Tavily API"
icon: square-poll-horizontal
mode: "wide"
---
The `TavilyExtractorTool` allows CrewAI agents to extract structured content from web pages using the Tavily API. It can process single URLs or lists of URLs and provides options for controlling the extraction depth and including images.

View File

@@ -2,6 +2,7 @@
title: "Tavily Search Tool"
description: "Perform comprehensive web searches using the Tavily Search API"
icon: "magnifying-glass"
mode: "wide"
---
The `TavilySearchTool` provides an interface to the Tavily Search API, enabling CrewAI agents to perform comprehensive web searches. It allows for specifying search depth, topics, time ranges, included/excluded domains, and whether to include direct answers, raw content, or images in the results.

View File

@@ -2,6 +2,7 @@
title: Website RAG Search
description: The `WebsiteSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a website.
icon: globe-stand
mode: "wide"
---
# `WebsiteSearchTool`

View File

@@ -2,6 +2,7 @@
title: YouTube Channel RAG Search
description: The `YoutubeChannelSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a Youtube channel.
icon: youtube
mode: "wide"
---
# `YoutubeChannelSearchTool`

View File

@@ -2,6 +2,7 @@
title: YouTube Video RAG Search
description: The `YoutubeVideoSearchTool` is designed to perform a RAG (Retrieval-Augmented Generation) search within the content of a Youtube video.
icon: youtube
mode: "wide"
---
# `YoutubeVideoSearchTool`

View File

@@ -0,0 +1,31 @@
---
title: Overview
description: Integrations for deploying and automating crews with external platforms
icon: face-smile
mode: "wide"
---
## Available Integrations
<CardGroup cols={2}>
<Card
title="Bedrock Invoke Agent Tool"
icon="cloud"
href="/en/tools/tool-integrations/bedrockinvokeagenttool"
color="#0891B2"
>
Invoke Amazon Bedrock Agents from CrewAI to orchestrate actions across AWS services.
</Card>
<Card
title="CrewAI Automation Tool"
icon="bolt"
href="/en/tools/tool-integrations/crewaiautomationtool"
color="#7C3AED"
>
Automate deployment and operations by integrating CrewAI with external platforms and workflows.
</Card>
</CardGroup>
Use these integrations to connect CrewAI with your infrastructure and workflows.

View File

@@ -2,6 +2,7 @@
title: Bright Data Tools
description: Bright Data integrations for SERP search, Web Unlocker scraping, and Dataset API.
icon: spider
mode: "wide"
---
# Bright Data Tools

View File

@@ -2,6 +2,7 @@
title: Browserbase Web Loader
description: Browserbase is a developer platform to reliably run, manage, and monitor headless browsers.
icon: browser
mode: "wide"
---
# `BrowserbaseLoadTool`

View File

@@ -2,6 +2,7 @@
title: Firecrawl Crawl Website
description: The `FirecrawlCrawlWebsiteTool` is designed to crawl and convert websites into clean markdown or structured data.
icon: fire-flame
mode: "wide"
---
# `FirecrawlCrawlWebsiteTool`

View File

@@ -2,6 +2,7 @@
title: Firecrawl Scrape Website
description: The `FirecrawlScrapeWebsiteTool` is designed to scrape websites and convert them into clean markdown or structured data.
icon: fire-flame
mode: "wide"
---
# `FirecrawlScrapeWebsiteTool`

View File

@@ -2,6 +2,7 @@
title: Firecrawl Search
description: The `FirecrawlSearchTool` is designed to search websites and convert them into clean markdown or structured data.
icon: fire-flame
mode: "wide"
---
# `FirecrawlSearchTool`

View File

@@ -2,6 +2,7 @@
title: Hyperbrowser Load Tool
description: The `HyperbrowserLoadTool` enables web scraping and crawling using Hyperbrowser.
icon: globe
mode: "wide"
---
# `HyperbrowserLoadTool`

View File

@@ -2,6 +2,7 @@
title: "Overview"
description: "Extract data from websites and automate browser interactions with powerful scraping tools"
icon: "face-smile"
mode: "wide"
---
These tools enable your agents to interact with the web, extract data from websites, and automate browser-based tasks. From simple web scraping to complex browser automation, these tools cover all your web interaction needs.

View File

@@ -7,6 +7,7 @@ description: >
- `Google Seach`
- `Universal`
icon: globe
mode: "wide"
---
## Installation

View File

@@ -2,6 +2,7 @@
title: Scrape Element From Website Tool
description: The `ScrapeElementFromWebsiteTool` enables CrewAI agents to extract specific elements from websites using CSS selectors.
icon: code
mode: "wide"
---
# `ScrapeElementFromWebsiteTool`

View File

@@ -2,6 +2,7 @@
title: Scrapegraph Scrape Tool
description: The `ScrapegraphScrapeTool` leverages Scrapegraph AI's SmartScraper API to intelligently extract content from websites.
icon: chart-area
mode: "wide"
---
# `ScrapegraphScrapeTool`

View File

@@ -2,6 +2,7 @@
title: Scrape Website
description: The `ScrapeWebsiteTool` is designed to extract and read the content of a specified website.
icon: magnifying-glass-location
mode: "wide"
---
# `ScrapeWebsiteTool`

View File

@@ -2,6 +2,7 @@
title: Scrapfly Scrape Website Tool
description: The `ScrapflyScrapeWebsiteTool` leverages Scrapfly's web scraping API to extract content from websites in various formats.
icon: spider
mode: "wide"
---
# `ScrapflyScrapeWebsiteTool`

View File

@@ -2,6 +2,7 @@
title: Selenium Scraper
description: The `SeleniumScrapingTool` is designed to extract and read the content of a specified website using Selenium.
icon: clipboard-user
mode: "wide"
---
# `SeleniumScrapingTool`

View File

@@ -2,6 +2,7 @@
title: Serper Scrape Website
description: The `SerperScrapeWebsiteTool` is designed to scrape websites and extract clean, readable content using Serper's scraping API.
icon: globe
mode: "wide"
---
# `SerperScrapeWebsiteTool`

View File

@@ -2,6 +2,7 @@
title: Spider Scraper
description: The `SpiderTool` is designed to extract and read the content of a specified website using Spider.
icon: spider-web
mode: "wide"
---
# `SpiderTool`

View File

@@ -2,6 +2,7 @@
title: Stagehand Tool
description: Web automation tool that integrates Stagehand with CrewAI for browser interaction and automation
icon: hand
mode: "wide"
---