mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 15:09:22 +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>
114 lines
2.8 KiB
Plaintext
114 lines
2.8 KiB
Plaintext
---
|
||
title: Arxiv Paper Tool
|
||
description: The `ArxivPaperTool` searches arXiv for papers matching a query and optionally downloads PDFs.
|
||
icon: box-archive
|
||
mode: "wide"
|
||
---
|
||
|
||
# `ArxivPaperTool`
|
||
|
||
## Description
|
||
|
||
The `ArxivPaperTool` queries the arXiv API for academic papers and returns compact, readable results. It can also optionally download PDFs to disk.
|
||
|
||
## Installation
|
||
|
||
This tool has no special installation beyond `crewai-tools`.
|
||
|
||
```shell
|
||
uv add crewai-tools
|
||
```
|
||
|
||
No API key is required. This tool uses the public arXiv Atom API.
|
||
|
||
## Steps to Get Started
|
||
|
||
1. Initialize the tool.
|
||
2. Provide a `search_query` (e.g., "transformer neural network").
|
||
3. Optionally set `max_results` (1–100) and enable PDF downloads in the constructor.
|
||
|
||
## Example
|
||
|
||
```python Code
|
||
from crewai import Agent, Task, Crew
|
||
from crewai_tools import ArxivPaperTool
|
||
|
||
tool = ArxivPaperTool(
|
||
download_pdfs=False,
|
||
save_dir="./arxiv_pdfs",
|
||
use_title_as_filename=True,
|
||
)
|
||
|
||
agent = Agent(
|
||
role="Researcher",
|
||
goal="Find relevant arXiv papers",
|
||
backstory="Expert at literature discovery",
|
||
tools=[tool],
|
||
verbose=True,
|
||
)
|
||
|
||
task = Task(
|
||
description="Search arXiv for 'transformer neural network' and list top 5 results.",
|
||
expected_output="A concise list of 5 relevant papers with titles, links, and summaries.",
|
||
agent=agent,
|
||
)
|
||
|
||
crew = Crew(agents=[agent], tasks=[task])
|
||
result = crew.kickoff()
|
||
```
|
||
|
||
### Direct usage (without Agent)
|
||
|
||
```python Code
|
||
from crewai_tools import ArxivPaperTool
|
||
|
||
tool = ArxivPaperTool(
|
||
download_pdfs=True,
|
||
save_dir="./arxiv_pdfs",
|
||
)
|
||
print(tool.run(search_query="mixture of experts", max_results=3))
|
||
```
|
||
|
||
## Parameters
|
||
|
||
### Initialization Parameters
|
||
|
||
- `download_pdfs` (bool, default `False`): Whether to download PDFs.
|
||
- `save_dir` (str, default `./arxiv_pdfs`): Directory to save PDFs.
|
||
- `use_title_as_filename` (bool, default `False`): Use paper titles for filenames.
|
||
|
||
### Run Parameters
|
||
|
||
- `search_query` (str, required): The arXiv search query.
|
||
- `max_results` (int, default `5`, range 1–100): Number of results.
|
||
|
||
## Output format
|
||
|
||
The tool returns a human‑readable list of papers with:
|
||
- Title
|
||
- Link (abs page)
|
||
- Snippet/summary (truncated)
|
||
|
||
When `download_pdfs=True`, PDFs are saved to disk and the summary mentions saved files.
|
||
|
||
## Usage Notes
|
||
|
||
- The tool returns formatted text with key metadata and links.
|
||
- When `download_pdfs=True`, PDFs will be stored in `save_dir`.
|
||
|
||
## Troubleshooting
|
||
|
||
- If you receive a network timeout, re‑try or reduce `max_results`.
|
||
- Invalid XML errors indicate an arXiv response parse issue; try a simpler query.
|
||
- File system errors (e.g., permission denied) may occur when saving PDFs; ensure `save_dir` is writable.
|
||
|
||
## Related links
|
||
|
||
- arXiv API docs: https://info.arxiv.org/help/api/index.html
|
||
|
||
## Error Handling
|
||
|
||
- Network issues, invalid XML, and OS errors are handled with informative messages.
|
||
|
||
|