You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,10 +117,10 @@ The functions include a built-in encryption mechanism for sensitive information:
117
117
> [!TIP]
118
118
>**N8N Workflow Automation Integration**
119
119
>
120
-
> Connect Open WebUI with N8N to leverage powerful workflow automation. Includes AI Agent tool usage display forcomplete transparency into your agent's actions.
120
+
> Connect Open WebUI with N8N to leverage powerful workflow automation. Includes configurable AI Agent tool usage display forcomplete transparency into your agent's actions.
121
121
122
122
- Integrates **Open WebUI** with **N8N**, an automation and workflow platform.
123
-
- **AI Agent Tool Usage Display (v2.2.0)** 🛠️: Shows tool calls from N8N AI Agent workflows with collapsible details (non-streaming mode only).
123
+
- **AI Agent Tool Usage Display (v2.2.0)** 🛠️: Shows tool calls from N8N AI Agent workflows with three verbosity levels (minimal, compact, detailed) and customizable length limits (non-streaming mode only).
124
124
- Streaming and non-streaming support for real-time and batch data processing.
125
125
- Sends messages from Open WebUI to an **N8N webhook**.
126
126
- Supports real-time message processing with dynamic field handling.
Copy file name to clipboardExpand all lines: docs/n8n-integration.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,15 @@ This integration allows Open WebUI to communicate with workflows created in **n8
22
22
## Features
23
23
24
24
> [!TIP]
25
-
> **AI Agent Tool Usage Display (NEW in v2.2.0)** 🛠️
25
+
> **AI Agent Tool Usage Display (v2.2.0)** 🛠️
26
26
>
27
-
> Automatically extracts and displays tool calls from N8N AI Agent workflows in **non-streaming mode**. Shows tool names, inputs, and results in collapsible `<details>` sections. Parses the `intermediateSteps` array to provide transparency into the AI agent's workflow execution.
27
+
> Automatically extracts and displays tool calls from N8N AI Agent workflows in **non-streaming mode**.
Starting with version 2.2.0, the N8N pipeline automatically displays AI Agent tool calls in a user-friendly format. When your N8N workflow includes an AI Agent node that uses tools (like Wikipedia, Date/Time, Calculator, etc.), the pipeline will extract and display detailed information about each tool invocation.
6
6
7
+
Version 2.2.0 includes **configurable verbosity levels** and **length limits** for tool display, allowing you to control how detailed the tool information is shown.
8
+
7
9
## Important Limitation
8
10
9
11
> [!IMPORTANT]
@@ -17,30 +19,92 @@ Starting with version 2.2.0, the N8N pipeline automatically displays AI Agent to
17
19
18
20
- Works with **non-streaming** N8N responses
19
21
- Automatically extracts `intermediateSteps` from the N8N response payload
20
-
- No additional configuration required
22
+
- Configurable verbosity levels (v2.2.0+)
23
+
- Customizable length limits for inputs and outputs (v2.2.0+)
24
+
25
+
### Verbosity Levels (v2.2.0+)
26
+
27
+
> [!TIP]
28
+
> **Configure via Pipeline Settings**: Set `TOOL_DISPLAY_VERBOSITY` to control the detail level.
29
+
30
+
#### 1. **Minimal** (`minimal`)
31
+
32
+
Shows only tool names in a collapsible list:
33
+
34
+
```txt
35
+
🛠️ Tool Calls (4 steps) ▶
36
+
1. Date_Time
37
+
2. Crypto
38
+
3. Wikipedia
39
+
4. Calculator
40
+
```
41
+
42
+
**Best for**: Quick overview, minimal UI clutter, collapsible for space-saving
> **Control Output Size**: Set `TOOL_INPUT_MAX_LENGTH` and `TOOL_OUTPUT_MAX_LENGTH` to limit text length.
80
+
81
+
-**`TOOL_INPUT_MAX_LENGTH`** (default: 500): Maximum characters for tool input display in `detailed` and `compact` modes
82
+
-**`TOOL_OUTPUT_MAX_LENGTH`** (default: 500): Maximum characters for tool output/observation display
83
+
- Set to **0** for unlimited length (no truncation)
84
+
85
+
> [!IMPORTANT]
86
+
> **Behavior with `0` (unlimited)**:
87
+
>
88
+
> -**Detailed mode**: Shows complete input and output without any truncation
89
+
> -**Compact mode**: For inputs, shows full data. For outputs, still uses a 100-character preview for UI readability
90
+
91
+
**Example**: For very long Wikipedia results, set `TOOL_OUTPUT_MAX_LENGTH` to 200 to show only the first 200 characters, or set to 0 to show everything.
92
+
93
+
### Rich Display Format (Detailed Mode)
23
94
24
95
Each tool call is displayed with:
25
96
26
97
- 🔧 **Tool Name**: The name of the tool that was invoked
27
98
- 🆔 **Call ID**: Unique identifier for debugging (e.g., `call_FB0sIgrwuIGJkOaROor7raU2`)
28
-
- 📥 **Input**: The parameters passed to the tool (formatted as JSON)
29
-
- 📤 **Result**: The tool's response/observation
30
-
- 📝 **Log**: Optional log messages from the tool execution
99
+
- 📥 **Input**: The parameters passed to the tool (formatted as JSON, respects `TOOL_INPUT_MAX_LENGTH`)
100
+
- 📤 **Result**: The tool's response/observation (respects `TOOL_OUTPUT_MAX_LENGTH`)
101
+
- 📝 **Log**: Optional log messages from the tool execution (max 200 chars)
31
102
32
103
### Collapsible UI
33
104
34
105
Uses HTML `<details>` tags for a clean, expandable interface:
35
106
36
-
```txt
37
-
🛠️ Tool Calls (3 steps) ▶
38
-
├─ Step 1: Date_Time ▶
39
-
├─ Step 2: Wikipedia ▶
40
-
└─ Step 3: Wikipedia ▶
41
-
```
42
-
43
-
Click to expand each step and view full details.
107
+
Click to expand each step and view full details (in detailed mode).
44
108
45
109
## Example
46
110
@@ -169,6 +233,36 @@ The display works with any N8N tool, including:
169
233
- 💾 Database queries
170
234
- And any custom tools you create!
171
235
236
+
## Configuration
237
+
238
+
### Pipeline Settings
239
+
240
+
Configure tool display in the N8N pipeline settings (Admin Panel → Functions → N8N Pipeline):
241
+
242
+
| Setting | Default | Description |
243
+
|---------|---------|-------------|
244
+
|`TOOL_DISPLAY_VERBOSITY`|`detailed`| Display mode: `minimal`, `compact`, or `detailed`|
245
+
|`TOOL_INPUT_MAX_LENGTH`|`500`| Maximum characters for tool input. Set to `0` for unlimited (no truncation) |
246
+
|`TOOL_OUTPUT_MAX_LENGTH`|`500`| Maximum characters for tool output. Set to `0` for unlimited in detailed mode (compact mode uses 100 char preview) |
247
+
248
+
### Recommendations
249
+
250
+
> [!TIP]
251
+
> **For Production Use**:
252
+
>
253
+
> - Use `compact` mode for cleaner UI with essential info
254
+
> - Set `TOOL_OUTPUT_MAX_LENGTH` to 200-300 for long outputs like Wikipedia
255
+
>
256
+
> **For Development/Debugging**:
257
+
>
258
+
> - Use `detailed` mode to see all information
259
+
> - Set lengths to 0 (unlimited) to see complete data
260
+
>
261
+
> **For Minimal UI**:
262
+
>
263
+
> - Use `minimal` mode to just show tool names
264
+
> - Perfect for when you only need to know which tools were called
265
+
172
266
## Troubleshooting
173
267
174
268
### Tool Calls Not Showing?
@@ -179,6 +273,7 @@ Check that:
179
273
2. ✅ The response includes the `intermediateSteps` array
180
274
3. ✅ The N8N pipeline version is 2.2.0 or higher
181
275
4. ✅ The response structure matches the expected format (see examples above)
276
+
5. ✅ You're using non-streaming mode (streaming doesn't support tool display)
0 commit comments