Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@
"edge/en/tools/automation/apifyactorstool",
"edge/en/tools/automation/composiotool",
"edge/en/tools/automation/multiontool",
"edge/en/tools/automation/waittool",
"edge/en/tools/automation/zapieractionstool"
]
}
Expand Down
4 changes: 4 additions & 0 deletions docs/edge/en/tools/automation/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ These tools enable your agents to automate workflows, integrate with external pl
Automate browser interactions and web-based workflows.
</Card>

<Card title="Wait Tool" icon="hourglass-half" href="/edge/en/tools/automation/waittool">
Comment thread
joaomdmoura marked this conversation as resolved.
Pause before re-checking a long-running job such as a build or deployment.
</Card>

<Card title="Zapier Actions Adapter" icon="bolt" href="/en/tools/automation/zapieractionstool">
Expose Zapier Actions as CrewAI tools for automation across thousands of apps.
</Card>
Expand Down
124 changes: 124 additions & 0 deletions docs/edge/en/tools/automation/waittool.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
---
title: Wait Tool
description: The `WaitTool` lets an agent pause before checking a long-running job again.
icon: hourglass-half
mode: "wide"
---

## Overview

The `WaitTool` pauses execution for a given number of seconds. It exists because agents that
kick off long-running work — a sandbox build, a deployment, a batch import, an async API job —
otherwise have no way to let time pass. Without it, an agent either polls in a tight loop or
gives up before the work finishes.

The tool takes no API key and has no dependencies beyond the standard library.

## When to Use It

The tool's description tells the model to reach for it when out-of-band work needs real time
to progress:

- A sandbox build, test run, or script that is still executing
- A deployment or provisioning step that is still rolling out
- A batch import, export, or training job
- An async API that returned a job id to poll later
- A rate limit or backoff that has to cool down before retrying

The pattern the model is steered toward is: start the job, wait, check status, wait again if it
is still running. The description also tells it *not* to wait to pace a conversation or when the
information it needs is already available — waiting only lets clock time pass, it does not
advance or check the job.

## Installation

The tool ships with `crewai-tools`:

```shell
uv add crewai-tools
```

## Example

```python Code
from crewai import Agent, Crew, Task
from crewai.tools import tool
from crewai_tools import WaitTool

wait_tool = WaitTool()


@tool("Check build status")
def check_build_status_tool(build_id: str) -> str:
"""Return the current status of a build: queued, running, passed, or failed."""
# Replace this with a call to your own build system.
return my_ci_client.get_build(build_id).status


build_agent = Agent(
role="Build Monitor",
goal="Start the build and report its final status",
backstory="An engineer who knows that builds take time.",
tools=[wait_tool, check_build_status_tool],
Comment thread
coderabbitai[bot] marked this conversation as resolved.
verbose=True,
)

monitor_task = Task(
description=(
"Start the build, then wait and re-check its status until it finishes."
),
expected_output="The final build status.",
agent=build_agent,
)

crew = Crew(agents=[build_agent], tasks=[monitor_task])
result = crew.kickoff()
```

## Arguments

| Argument | Type | Required | Description |
| :-------- | :------ | :------- | :----------------------------------------------------------------------------- |
| `seconds` | `float` | ✅ | How many seconds to wait. Must be zero or greater. |
| `reason` | `str` | ❌ | Optional note on what is being waited for. Echoed back in the tool's result. |

## Initialization Parameters

| Parameter | Type | Default | Description |
| :------------ | :------ | :------ | :----------------------------------------------------------------------------------- |
| `max_seconds` | `float` | `300` | Upper bound for a single wait. Longer requests are capped to this value, not rejected. |

## Capping Long Waits

A single call waits at most `max_seconds`. If an agent asks for more, the tool waits the
maximum and says so in its result, so the agent can call it again rather than fail:

```python Code
wait_tool = WaitTool()
wait_tool.run(seconds=3600)
# 'Waited 300 seconds. Requested 3600 seconds, capped at 300 seconds per call -
# call this tool again if more waiting is needed.'
```

Raise the cap when a workflow genuinely needs longer single pauses:

```python Code
wait_tool = WaitTool(max_seconds=1800)
```

## Async Support

The tool implements both sync and async execution, so it does not block the event loop when
awaited:

```python Code
import asyncio


async def main():
result = await wait_tool.arun(seconds=30, reason="waiting for the sandbox build")
print(result)


asyncio.run(main())
```
Comment thread
coderabbitai[bot] marked this conversation as resolved.
2 changes: 2 additions & 0 deletions lib/crewai-tools/src/crewai_tools/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@
from crewai_tools.tools.tavily_search_tool.tavily_search_tool import TavilySearchTool
from crewai_tools.tools.txt_search_tool.txt_search_tool import TXTSearchTool
from crewai_tools.tools.vision_tool.vision_tool import VisionTool
from crewai_tools.tools.wait_tool.wait_tool import WaitTool
from crewai_tools.tools.weaviate_tool.vector_search import WeaviateVectorSearchTool
from crewai_tools.tools.website_search.website_search_tool import WebsiteSearchTool
from crewai_tools.tools.xml_search_tool.xml_search_tool import XMLSearchTool
Expand Down Expand Up @@ -321,6 +322,7 @@
"TavilyResearchTool",
"TavilySearchTool",
"VisionTool",
"WaitTool",
"WeaviateVectorSearchTool",
"WebsiteSearchTool",
"XMLSearchTool",
Expand Down
2 changes: 2 additions & 0 deletions lib/crewai-tools/src/crewai_tools/tools/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@
from crewai_tools.tools.tavily_search_tool.tavily_search_tool import TavilySearchTool
from crewai_tools.tools.txt_search_tool.txt_search_tool import TXTSearchTool
from crewai_tools.tools.vision_tool.vision_tool import VisionTool
from crewai_tools.tools.wait_tool.wait_tool import WaitTool
from crewai_tools.tools.weaviate_tool.vector_search import WeaviateVectorSearchTool
from crewai_tools.tools.website_search.website_search_tool import WebsiteSearchTool
from crewai_tools.tools.xml_search_tool.xml_search_tool import XMLSearchTool
Expand Down Expand Up @@ -304,6 +305,7 @@
"TavilyResearchTool",
"TavilySearchTool",
"VisionTool",
"WaitTool",
"WeaviateVectorSearchTool",
"WebsiteSearchTool",
"XMLSearchTool",
Expand Down
70 changes: 70 additions & 0 deletions lib/crewai-tools/src/crewai_tools/tools/wait_tool/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# WaitTool

The **WaitTool** pauses execution for a given number of seconds. Use it when an agent needs to
let time pass before re-checking a long-running job — a sandbox build, a deployment, a batch
import, an async API call.

No API key, no dependencies beyond the standard library.

## Arguments

| Argument | Type | Required | Description |
| --------- | ------- | -------- | ---------------------------------------------------------------------------- |
| `seconds` | `float` | ✅ | How many seconds to wait. Must be zero or greater. |
| `reason` | `str` | ❌ | Optional note on what is being waited for. Echoed back in the tool's result. |

## Initialization Parameters

| Parameter | Type | Default | Description |
| ------------- | ------- | ------- | -------------------------------------------------------------------------------------- |
| `max_seconds` | `float` | `300` | Upper bound for a single wait. Longer requests are capped to this value, not rejected. |

## Usage Example

```python
from crewai import Agent
from crewai.tools import tool
from crewai_tools import WaitTool

wait_tool = WaitTool()


@tool("Check build status")
def check_build_status_tool(build_id: str) -> str:
"""Return the current status of a build: queued, running, passed, or failed."""
# Replace this with a call to your own build system.
return my_ci_client.get_build(build_id).status


agent = Agent(
role="Build Monitor",
goal="Start the build and report its final status",
backstory="An engineer who knows that builds take time.",
tools=[wait_tool, check_build_status_tool],
)
Comment thread
coderabbitai[bot] marked this conversation as resolved.
```

A single call waits at most `max_seconds`. Longer requests are capped and the result says so,
so the agent can simply call the tool again:

```python
wait_tool.run(seconds=3600)
# 'Waited 300 seconds. Requested 3600 seconds, capped at 300 seconds per call -
# call this tool again if more waiting is needed.'

WaitTool(max_seconds=1800).run(seconds=900)
# 'Waited 900 seconds.'
```

Async execution is supported and does not block the event loop:

```python
import asyncio


async def main():
print(await wait_tool.arun(seconds=30, reason="waiting for the sandbox build"))


asyncio.run(main())
```
4 changes: 4 additions & 0 deletions lib/crewai-tools/src/crewai_tools/tools/wait_tool/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from crewai_tools.tools.wait_tool.wait_tool import WaitTool, WaitToolSchema


__all__ = ["WaitTool", "WaitToolSchema"]
Loading
Loading