mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +00:00
93dafe2637
Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com>
146 lines
4.0 KiB
Plaintext
146 lines
4.0 KiB
Plaintext
---
|
|
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.
|
|
|
|
## **Tool Categories**
|
|
|
|
<CardGroup cols={2}>
|
|
<Card
|
|
title="File & Document"
|
|
icon="folder-open"
|
|
href="/en/tools/file-document/overview"
|
|
color="#3B82F6"
|
|
>
|
|
Read, write, and search through various file formats including PDF, DOCX, JSON, CSV, and more. Perfect for document processing workflows.
|
|
</Card>
|
|
|
|
<Card
|
|
title="Web Scraping & Browsing"
|
|
icon="globe"
|
|
href="/en/tools/web-scraping/overview"
|
|
color="#10B981"
|
|
>
|
|
Extract data from websites, automate browser interactions, and scrape content at scale with tools like Firecrawl, Selenium, and more.
|
|
</Card>
|
|
|
|
<Card
|
|
title="Search & Research"
|
|
icon="magnifying-glass"
|
|
href="/en/tools/search-research/overview"
|
|
color="#F59E0B"
|
|
>
|
|
Perform web searches, find code repositories, research YouTube content, and discover information across the internet.
|
|
</Card>
|
|
|
|
<Card
|
|
title="Database & Data"
|
|
icon="database"
|
|
href="/en/tools/database-data/overview"
|
|
color="#8B5CF6"
|
|
>
|
|
Connect to SQL databases, vector stores, and data warehouses. Query MySQL, PostgreSQL, Snowflake, Qdrant, and Weaviate.
|
|
</Card>
|
|
|
|
<Card
|
|
title="AI & Machine Learning"
|
|
icon="brain"
|
|
href="/en/tools/ai-ml/overview"
|
|
color="#EF4444"
|
|
>
|
|
Generate images with DALL-E, process vision tasks, integrate with LangChain, build RAG systems, and leverage code interpreters.
|
|
</Card>
|
|
|
|
<Card
|
|
title="Cloud & Storage"
|
|
icon="cloud"
|
|
href="/en/tools/cloud-storage/overview"
|
|
color="#06B6D4"
|
|
>
|
|
Interact with cloud services including AWS S3, Amazon Bedrock, and other cloud storage and AI services.
|
|
</Card>
|
|
|
|
<Card
|
|
title="Automation"
|
|
icon="bolt"
|
|
href="/en/tools/automation/overview"
|
|
color="#84CC16"
|
|
>
|
|
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>
|
|
|
|
## **Quick Access**
|
|
|
|
Need a specific tool? Here are some popular choices:
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="RAG Tool" icon="image" href="/en/tools/ai-ml/ragtool">
|
|
Implement Retrieval-Augmented Generation
|
|
</Card>
|
|
<Card title="Serper Dev" icon="book-atlas" href="/en/tools/search-research/serperdevtool">
|
|
Google search API
|
|
</Card>
|
|
<Card title="File Read" icon="file" href="/en/tools/file-document/filereadtool">
|
|
Read any file type
|
|
</Card>
|
|
<Card title="Scrape Website" icon="globe" href="/en/tools/web-scraping/scrapewebsitetool">
|
|
Extract web content
|
|
</Card>
|
|
<Card title="Code Interpreter" icon="code" href="/en/tools/ai-ml/codeinterpretertool">
|
|
Execute Python code
|
|
</Card>
|
|
<Card title="S3 Reader" icon="cloud" href="/en/tools/cloud-storage/s3readertool">
|
|
Access AWS S3 files
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## **Getting Started**
|
|
|
|
To use any tool in your CrewAI project:
|
|
|
|
1. **Import** the tool in your crew configuration
|
|
2. **Add** it to your agent's tools list
|
|
3. **Configure** any required API keys or settings
|
|
|
|
```python
|
|
from crewai_tools import FileReadTool, SerperDevTool
|
|
|
|
# Add tools to your agent
|
|
agent = Agent(
|
|
role="Research Analyst",
|
|
tools=[FileReadTool(), SerperDevTool()],
|
|
# ... other configuration
|
|
)
|
|
```
|
|
|
|
## **Max Usage Count**
|
|
|
|
You can set a maximum usage count for a tool to prevent it from being used more than a certain number of times.
|
|
By default, the max usage count is unlimited.
|
|
|
|
|
|
|
|
```python
|
|
from crewai_tools import FileReadTool
|
|
|
|
tool = FileReadTool(max_usage_count=5, ...)
|
|
```
|
|
|
|
|
|
|
|
Ready to explore? Pick a category above to discover tools that fit your use case!
|