OpenWebUI Tools

This repository contains a collection of tools designed to extend the functionality of OpenWebUI. Each tool is located in its own directory and includes a README.md file with specific instructions.

Available Tools

• Redmine Issue Fetcher: A tool to fetch live issue details from a Redmine instance directly into your chat.
• Sample Tool: A minimal example and template for creating your own custom OpenWebUI tools.

Tool Installation

There are two primary ways to install and use these tools in your OpenWebUI instance:

1. Manual Installation (Copy & Paste)

This is the most straightforward method for getting a tool running quickly.

1. Navigate to Your Workspace: In OpenWebUI, go to Workspace > Tools.
2. Create a New Tool: Click the Create New Tool button.
3. Enter Tool Details:
   • Tool Name: Give your tool a descriptive name (e.g., "Redmine Issue Fetcher"). A unique Tool ID will be automatically generated.
   • Description: Copy the description from the top of the tool's Python file (e.g., redmine_issue_fetcher.py) for consistency.
   • Tool Code: Paste the entire content of the tool's Python file into the code editor.
4. Save and Enable: Save the tool. You can then enable it for specific models in the Workspace > Models section.

2. Community Hub (Recommended for Sharing)

You can also contribute your tools to the official OpenWebUI community hub, making them accessible to everyone.

1. Submit Your Tool: Visit openwebui.com and follow the instructions for adding a new tool.
2. Import from Hub: Once your tool is approved and listed, you and other users can easily import it into your OpenWebUI instances directly from the hub.

Usage

After installing a tool, follow the specific setup and usage instructions in its respective README.md file. This may involve configuring global or user-specific settings (valves), such as API keys or URLs.