Skip to content

docs: update Long Running Function warning #693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 12, 2025
Merged

docs: update Long Running Function warning #693

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fced315
docs: Long Run Function, add warning and clarification
joefernandez Sep 12, 2025
2a5ac11
docs: update Long Run Function warning
joefernandez Sep 12, 2025
ce80564
Merge branch 'main' into long-run-warning
joefernandez Sep 12, 2025
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
7 changes: 3 additions & 4 deletions docs/tools/function-tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,11 +161,10 @@ This tool is designed to help you start and manage tasks that are handled outsid
When using a `LongRunningFunctionTool`, your function can initiate the long-running operation and optionally return an **initial result**, such as a long-running operation id. Once a long running function tool is invoked the agent runner pauses the agent run and lets the agent client to decide whether to continue or wait until the long-running operation finishes. The agent client can query the progress of the long-running operation and send back an intermediate or final response. The agent can then continue with other tasks. An example is the human-in-the-loop scenario where the agent needs human approval before proceeding with a task.

!!! warning "Warning: Execution handling"
Long Running Function Tools are designed to help you *manage* long running tasks
as part of your agent workflow, but ***not perform*** the actual, long task.
Long Running Function Tools are designed to help you start and *manage* long running
tasks as part of your agent workflow, but ***not perform*** the actual, long task.
For tasks that require significant time to complete, you should implement a separate
server to do the task or use a service such as
[Cloud Tasks](https://cloud.google.com/tasks/docs).
server to do the task.

!!! tip "Tip: Parallel execution"
Depending on the type of tool you are building, designing for asychronous
Expand Down