Skip to content

Commit 36b1745

Browse files
committed
docs(tools): add Quick Selection Guide and common scenarios
Adds decision tree and real-world examples to existing Tools taxonomy: - ASCII decision tree for quick tool type selection - 6 common use cases with specific recommendations - Integrates with existing Native/Workspace/MCP/OpenAPI explanations Addresses user confusion about when to use each tool type. Verified against existing UI paths and security warnings. AI-assisted drafting; manually reviewed and validated. Signed-off-by: Hera and Hades Signed-off-by: HeraAndHades <christian93neumann@gmail.com>
1 parent 500526a commit 36b1745

File tree

1 file changed

+71
-1
lines changed
  • docs/features/extensibility/plugin/tools

1 file changed

+71
-1
lines changed

docs/features/extensibility/plugin/tools/index.mdx

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,77 @@ These are **Python scripts** that run directly within the Open WebUI environment
4747
- **MCPO (Proxy)**: Most community MCP servers use `stdio` (local command line). To use these in Open WebUI, you use the [**MCPO Proxy**](../../plugin/tools/openapi-servers/mcp.mdx) to bridge the connection.
4848

4949
### 4. OpenAPI / Function Calling Servers
50-
Generic web servers that provide an OpenAPI (`.json` or `.yaml`) specification. Open WebUI can ingest these specs and treat every endpoint as a tool.
50+
Generic web servers that provide an OpenAPI (`.json` or `.yaml`) specification.
51+
Open WebUI can ingest these specs and treat every endpoint as a tool.
52+
53+
---
54+
55+
## Quick Selection Guide
56+
57+
🎯 Not sure which tool type to use?
58+
Follow this decision tree.
59+
60+
### Decision Tree
61+
62+
```
63+
Do you need to add new AI capabilities (web search, image gen, etc.)?
64+
├── YES → Use Native Features (built-in)
65+
│ └── Enable in Admin Settings, toggle per-chat
66+
67+
└── NO → Continue...
68+
69+
Do you need custom Python code to run on the server?
70+
├── YES → Continue...
71+
│ ├── Is this a simple input/output transformation?
72+
│ │ ├── YES → Use Functions (Filters/Pipes)
73+
│ │ └── NO → Use Workspace Tools
74+
│ │
75+
│ └── Need to offload heavy processing?
76+
│ ├── YES → Use Pipelines (separate container)
77+
│ └── NO → Use Workspace Tools
78+
79+
└── NO → Continue...
80+
81+
Do you need to connect external services via API?
82+
├── YES → Use OpenAPI Servers or MCP
83+
│ ├── Standard REST API? → OpenAPI Server
84+
│ └── MCP-compatible service? → MCP (via HTTP or MCPO proxy)
85+
86+
└── NO → You probably don't need tools!
87+
```
88+
89+
### Common Scenarios
90+
91+
**"I want the AI to search the web"**
92+
→ Use Native Web Search.
93+
Enable in Admin > Settings > Web Search.
94+
Toggle in chat UI.
95+
No code required.
96+
97+
**"I need a custom weather lookup API"**
98+
→ Use Workspace Tools.
99+
Write Python to call weather API.
100+
Simple, integrated with Open WebUI.
101+
102+
**"I want to filter out PII before sending to AI"**
103+
→ Use Functions (Filter).
104+
Transform messages before they reach the model.
105+
Lightweight processing.
106+
107+
**"I need to run heavy ML models for document classification"**
108+
→ Use Pipelines.
109+
Runs in separate container.
110+
Doesn't slow down main Open WebUI.
111+
112+
**"I want to connect to my company's internal API"**
113+
→ Use OpenAPI Server.
114+
Provide OpenAPI spec.
115+
Automatic tool generation.
116+
117+
**"I have a Claude Desktop MCP server I want to use"**
118+
→ Use MCP via MCPO.
119+
Use MCPO proxy to bridge stdio MCP to HTTP.
120+
Connect in Settings > Connections.
51121

52122
---
53123

0 commit comments

Comments
 (0)