Added docs for TavilyGetResearch

[manisrinivasan2k1]

• added documentation for TavilyGetResearch (Tool already exists but doc doesn't)

Summary by CodeRabbit

• Documentation
  • Added comprehensive docs for TavilyGetResearchTool to retrieve status and results from existing Tavily research tasks.
  • Updated tools overview to include both Tavily research tools and Python examples for synchronous and asynchronous usage.
  • Updated documentation index/menus to reference the new TavilyGetResearchTool across relevant listings and sections.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4f6540c0-3c13-4ee4-be3c-2475ce02bd0a

📥 Commits

Reviewing files that changed from the base of the PR and between 1c898ce and e54e2a8.

📒 Files selected for processing (1)

• docs/docs.json

---

📝 Walkthrough

Walkthrough

This PR adds documentation for a new TavilyGetResearchTool that retrieves status and results from existing Tavily research tasks. The overview page is updated with tool cards and code examples, while the documentation navigation indices are extended to reference the new tool page.

Changes

TavilyGetResearchTool Documentation

Layer / File(s)	Summary
Overview page integration and examples docs/en/tools/search-research/overview.mdx	Two new Tavily tool cards are added to the tools overview, and the Python example code is updated to import, instantiate, and include both TavilyResearchTool and TavilyGetResearchTool in the agent's tools list.
TavilyGetResearchTool documentation page docs/en/tools/search-research/tavilygetresearchtool.mdx	New documentation file explaining how to use TavilyGetResearchTool to retrieve status and results of Tavily research tasks by request_id. Includes frontmatter, installation, environment setup, sync/async usage examples, configuration options, common workflow scenarios, and JSON response format details.
Documentation navigation and index updates docs/docs.json	The new tool entry en/tools/search-research/tavilygetresearchtool is registered across multiple navigation lists alongside the tavilyresearchtool entry to ensure discoverability throughout the docs structure.

🎯 2 (Simple) | ⏱️ ~8 minutes

• crewAIInc/crewAI#5707: Adds the same Tavily get-research documentation and docs.json entries (overlapping changes).

Suggested reviewers:

• lorenzejay
• greysonlalonde

"I'm a rabbit with docs to share,
Tavily lookup shows results with care.
Request IDs fetched, sync or async delight,
Docs now guide you morning to night.
Hoppity-hop — the tools are right!"

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Added docs for TavilyGetResearch' accurately reflects the main change: adding documentation for the TavilyGetResearchTool. However, it omits mention of TavilyResearchTool documentation and docs.json updates also included in the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/en/tools/search-research/tavilygetresearchtool.mdx`:
- Around line 64-72: The top-level await in the example will raise SyntaxError
in a standard .py file; wrap the call to TavilyGetResearchTool._arun inside an
async function (e.g., async def main()) and run it with asyncio.run(main()).
Import asyncio, move the await into main, optionally print the returned
status_result, and invoke asyncio.run(main()) so the example is executable.
- Line 78: The docs incorrectly reference private methods _run and _arun; update
the text and examples to use the public API names run() for synchronous calls
and arun() for async calls (replace any occurrences of `_run` with `run` and
`_arun` or `_arun()` with `arun`/`arun()`), and adjust the sentence “Use either
_run/_arun” to “Use either run/arun” so examples and descriptions consistently
show the public methods run() and arun().

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 44e9d2a8-6efe-4b20-8c53-d3cf2adfcc9c

📥 Commits

Reviewing files that changed from the base of the PR and between 63a9e7e and 1c898ce.

📒 Files selected for processing (3)

• docs/docs.json
• docs/en/tools/search-research/overview.mdx
• docs/en/tools/search-research/tavilygetresearchtool.mdx