How to end invocation in tool?

[mrcaidev]

I have tried tool_context._invocation_context.end_invocation = True but it doesn't work.

[adk-bot]

Response from ADK Answering Agent (experimental, answer may be inaccurate)

TLDR: To end the invocation from within a tool, you should set the end_invocation attribute on the context object to True. Instead of tool_context._invocation_context.end_invocation = True, you should likely be using a direct property on the context object itself.

---

Hello! Based on the ADK documentation, you can terminate an invocation early by setting the end_invocation flag to True on the context object that is available within your tool or callback. [1]

While you have tried accessing it through a private _invocation_context attribute, the intended way is likely more direct. The context object passed to tools and callbacks provides access to control flags like end_invocation. [1]

You should try setting it directly on the context object passed to your tool function, like this:

from google.adk.agents.invocation_context import InvocationContext

def my_custom_tool(some_arg: str, tool_context: InvocationContext):
  # some logic...
  if should_terminate:
    print("Ending invocation early.")
    tool_context.end_invocation = True
    return {"status": "Invocation terminated"}
  # ... continue normal execution
  return {"status": "Completed successfully"}

The documentation indicates that setting end_invocation = True signals to the framework to stop processing and terminate the run gracefully. [1, 2]

[1] https://google.github.io/adk-docs/streaming/dev-guide/part3/
[2] https://google.github.io/adk-docs/context/