Workflow Tools Configuration
π Turn Workflows Into Agent Tools
The Workflows tab is where your AI agent gains the superpower to execute complex, multi-step automations on demand. By configuring workflows as tools, your agent can intelligently decide when and how to trigger sophisticated business processes based on conversation context, user requests, or specific conditionsβtransforming your agent from a simple chatbot into a powerful automation orchestrator.
π― What Are Workflow Tools?
Workflow tools allow your AI agent to execute pre-built visual workflows (with 193+ available nodes) as callable functions. When configured as tools:
Agent Decides When: The AI determines when a workflow should run based on user intent
Dynamic Input: Agent extracts parameters from conversation and passes them to the workflow
Real-Time Execution: Workflow runs and returns results back to the agent
Conversational Feedback: Agent interprets workflow output and responds naturally to the user
Error Handling: Agent can gracefully handle workflow failures and provide alternatives
ποΈ How Workflow Tools Work
When you add a workflow as a tool to your agent, the system creates a specialized function that:
Exposes Workflow Parameters: The workflow's input schema becomes the tool's parameter schema
Generates Tool Description: Uses the workflow's description to help the agent understand when to use it
Handles Execution: Runs the workflow in the background when the agent calls the tool
Returns Results: Provides workflow output, status, and any errors back to the agent
Enables Conversation: Agent interprets results and communicates naturally with the user
Execution Flow Example
βοΈ Configuring Workflow Tools
To configure a workflow as an agent tool, you need to provide the following configuration settings. These settings control how the agent interacts with and executes your workflow:
ποΈ Tool Configuration Settings
1. Workflow Selection
Workflow ID (Required)
Choose which workflow this tool will execute
Only workflows in your workspace are available
Workflow must have a defined input schema
2. Tool Description
Description (Optional, but Highly Recommended)
Overrides the workflow's default description
Helps the agent understand when and how to use this tool
Should clearly explain the tool's purpose, required context, and expected outcomes
Writing Effective Tool Descriptions:
3. Timeout Configuration
Timeout (Required, Default: 150 seconds)
Maximum time (in seconds) the agent will wait for workflow completion
Range: 1-300 seconds (5 minutes maximum)
If exceeded, agent receives timeout error and can respond accordingly
Handling Timeouts:
4. Input Configuration (Pre-filled Parameters)
Input Config (Optional)
Pre-configure specific workflow input parameters
Remove parameters from agent's decision-making
Useful for setting constant values, security constraints, or workspace context
How Input Config Works
When you specify input_config, those parameters:
Are automatically filled with your specified values
Are removed from the tool's schema (agent doesn't see them)
Cannot be overridden by the agent
Advanced Input Config Patterns:
When to Use Input Config:
π Workflow Tool Response Format
When a workflow tool executes, it returns a structured response to the agent:
Success Response
Error Response (Detailed)
Error Response (Anonymous Users)
How Agents Handle Responses:
π Workflow Types & Use Cases
π¨ Data Processing Workflows as Tools
Configure data-focused workflows as agent tools for automated information handling:
Configuration Example:
βοΈ Business Process Workflows as Tools
Turn complex business processes into agent-callable tools:
π€ Integration Workflows as Tools
Connect external systems and services through workflow tools:
π Workflow Tool Best Practices
Design Principles
1. Clear Tool Descriptions
2. Appropriate Run Behavior Selection
3. Optimal Timeout Configuration
4. Strategic Input Config Usage
βοΈ Testing & Validation
Testing Workflow Tools
Pre-Deployment Testing Checklist
Testing Scenarios
π Workflow Execution Flow
When an agent calls a workflow tool, the system follows this execution sequence:
Execution Steps
Parameter Collection: Agent extracts required parameters from conversation context and user input
Input Template Application: Any pre-configured
input_configvalues are merged with agent-provided parametersParameter Substitution: Template variables (like
{{workspace_id}}) are replaced with actual valuesWorkflow Run Creation: System creates a workflow run record marked as "triggered_by: agent"
Workflow Execution: Workflow engine processes all nodes in the workflow
Event Callbacks: Each workflow step fires events that are processed and stored
Response Generation: Workflow completes and returns output, status, and any errors
Agent Response: Agent interprets the result and formulates a natural language response
Data Flow Example
π― Common Patterns & Examples
Pattern 1: Read-Only Data Query
Pattern 2: Confirmation-Required Action
Pattern 3: Multi-Step Process Automation
π Security & Error Handling
Security Considerations
Error Information Disclosure
The workflow tool automatically adjusts error detail based on user authentication:
Input Validation & Constraints
Error Handling Patterns
Transient Errors
Validation Errors
Business Logic Errors
π― Workflow Tool Configuration Checklist
Before deploying workflow tools with your agent:
Configuration
Testing
Security
Performance
π Additional Resources
Related Documentation
Workflows Overview: Learn about building workflows
Workflow Node Reference: Browse 193+ available nodes
Agent Configuration Overview: Complete agent setup guide
MCP Tools Configuration: Add external tool integrations
Sub-Agents: Coordinate multiple AI agents
Key Concepts
Workflow Input Schema: Defines parameters the workflow accepts
Tool Description: Guides agent on when to use the tool
Run Behavior: Controls automatic execution vs confirmation requirement
Input Config: Pre-fills constant values and enforces constraints
Timeout: Maximum execution time before timeout error
π‘ Quick Reference
Configuration Schema
Common Configuration Examples
Data Query Tool:
Financial Transaction Tool:
Process Automation Tool:
Transform your AI agent into a powerful automation orchestrator by connecting conversations directly to workflow execution.
Last updated
Was this helpful?