Skip to main content
Tools return results using ActionResult or simple strings.

Return Types

ActionResult Properties

  • extracted_content (default: None) - Main result passed to LLM, this is equivalent to returning a string.
  • include_extracted_content_only_once (default: False) - Set to True for large content to include it only once in the LLM input.
  • long_term_memory (default: None) - This is always included in the LLM input for all future steps.
  • error (default: None) - Error message, we catch exceptions and set this automatically. This is always included in the LLM input.
  • is_done (default: False) - Tool completes entire task
  • success (default: None) - Task success (only valid with is_done=True)
  • attachments (default: None) - Files to show user
  • metadata (default: None) - Debug/observability data

Why extracted_content and long_term_memory?

With this you control the context for the LLM.

1. Include short content always in context

2. Show long content once, remember subset in context

We save the full extracted_content to files which the LLM can read in future steps.

3. Don’t show long content, remember subset in context

Terminating the Agent

Set is_done=True to stop the agent completely. Use when your tool finishes the entire task: