Skip to content

docs(plugins): correct before_run_callback flow control behavior #1822

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

Open
yana-gi wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

docs(plugins): correct before_run_callback flow control behavior #1822

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions docs/plugins/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,12 +796,12 @@ object takes the potentially modified user message and prepares for execution.
The `before_run_callback` fires here, allowing for global setup before any agent
logic begins.

- **When It Runs:** Immediately after `runner.run()` is called, before
any other processing.
- **Purpose:** The first opportunity to inspect or modify the user's raw
input.
- **Flow Control:** Return a `types.Content` object to **replace** the
user's original message.
- **When It Runs:** After the `on_user_message_callback`, when the `Runner`
prepares for execution and before any agent logic begins.
- **Purpose:** Global setup or initialization before the invocation runs.
- **Flow Control:** Return a `types.Content` object to **halt execution**:
the `Runner` exits early and ends the run with that content as the result.
Return `None` to proceed normally.

The following code example shows the basic syntax of this callback:

Expand Down