mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel 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> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
121 lines
4.3 KiB
Plaintext
121 lines
4.3 KiB
Plaintext
---
|
|
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.
|
|
|
|
## **Available Tools**
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Serper Dev Tool" icon="google" href="/en/tools/search-research/serperdevtool">
|
|
Google search API integration for comprehensive web search capabilities.
|
|
</Card>
|
|
|
|
<Card title="Brave Search Tool" icon="shield" href="/en/tools/search-research/bravesearchtool">
|
|
Privacy-focused search with Brave's independent search index.
|
|
</Card>
|
|
|
|
<Card title="Exa Search Tool" icon="magnifying-glass" href="/en/tools/search-research/exasearchtool">
|
|
AI-powered search for finding specific and relevant content.
|
|
</Card>
|
|
|
|
<Card title="LinkUp Search Tool" icon="link" href="/en/tools/search-research/linkupsearchtool">
|
|
Real-time web search with fresh content indexing.
|
|
</Card>
|
|
|
|
<Card title="GitHub Search Tool" icon="github" href="/en/tools/search-research/githubsearchtool">
|
|
Search GitHub repositories, code, issues, and documentation.
|
|
</Card>
|
|
|
|
<Card title="Website Search Tool" icon="globe" href="/en/tools/search-research/websitesearchtool">
|
|
Search within specific websites and domains.
|
|
</Card>
|
|
|
|
<Card title="Code Docs Search Tool" icon="code" href="/en/tools/search-research/codedocssearchtool">
|
|
Search through code documentation and technical resources.
|
|
</Card>
|
|
|
|
<Card title="YouTube Channel Search" icon="youtube" href="/en/tools/search-research/youtubechannelsearchtool">
|
|
Search YouTube channels for specific content and creators.
|
|
</Card>
|
|
|
|
<Card title="YouTube Video Search" icon="play" href="/en/tools/search-research/youtubevideosearchtool">
|
|
Find and analyze YouTube videos by topic, keyword, or criteria.
|
|
</Card>
|
|
|
|
<Card title="Tavily Search Tool" icon="magnifying-glass" href="/en/tools/search-research/tavilysearchtool">
|
|
Comprehensive web search using Tavily's AI-powered search API.
|
|
</Card>
|
|
|
|
<Card title="Tavily Extractor Tool" icon="file-text" href="/en/tools/search-research/tavilyextractortool">
|
|
Extract structured content from web pages using the Tavily API.
|
|
</Card>
|
|
|
|
<Card title="Tavily Research Tool" icon="flask" href="/en/tools/search-research/tavilyresearchtool">
|
|
Run multi-step research tasks and get cited reports using the Tavily Research API.
|
|
</Card>
|
|
|
|
<Card title="Tavily Get Research Tool" icon="clipboard-list" href="/en/tools/search-research/tavilygetresearchtool">
|
|
Retrieve the status and results of an existing Tavily research task.
|
|
</Card>
|
|
|
|
<Card title="Arxiv Paper Tool" icon="box-archive" href="/en/tools/search-research/arxivpapertool">
|
|
Search arXiv and optionally download PDFs.
|
|
</Card>
|
|
|
|
<Card title="SerpApi Google Search" icon="search" href="/en/tools/search-research/serpapi-googlesearchtool">
|
|
Google search via SerpApi with structured results.
|
|
</Card>
|
|
|
|
<Card title="SerpApi Google Shopping" icon="cart-shopping" href="/en/tools/search-research/serpapi-googleshoppingtool">
|
|
Google Shopping queries via SerpApi.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## **Common Use Cases**
|
|
|
|
- **Market Research**: Search for industry trends and competitor analysis
|
|
- **Content Discovery**: Find relevant articles, videos, and resources
|
|
- **Code Research**: Search repositories and documentation for solutions
|
|
- **Lead Generation**: Research companies and individuals
|
|
- **Academic Research**: Find scholarly articles and technical papers
|
|
|
|
```python
|
|
from crewai_tools import (
|
|
GitHubSearchTool,
|
|
SerperDevTool,
|
|
TavilyExtractorTool,
|
|
TavilyGetResearchTool,
|
|
TavilyResearchTool,
|
|
TavilySearchTool,
|
|
YoutubeVideoSearchTool,
|
|
)
|
|
|
|
# Create research tools
|
|
web_search = SerperDevTool()
|
|
code_search = GitHubSearchTool()
|
|
video_research = YoutubeVideoSearchTool()
|
|
tavily_search = TavilySearchTool()
|
|
content_extractor = TavilyExtractorTool()
|
|
tavily_research = TavilyResearchTool()
|
|
tavily_get_research = TavilyGetResearchTool()
|
|
|
|
# Add to your agent
|
|
agent = Agent(
|
|
role="Research Analyst",
|
|
tools=[
|
|
web_search,
|
|
code_search,
|
|
video_research,
|
|
tavily_search,
|
|
content_extractor,
|
|
tavily_research,
|
|
tavily_get_research,
|
|
],
|
|
goal="Gather comprehensive information on any topic"
|
|
)
|
|
```
|