[PR #17792] [CLOSED] feat: Add customizable status to external tool calls #128207

New Issue

GiteaMirror · 2026-05-21T10:37:20-05:00

GiteaMirror commented

2026-05-21 10:37:20 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/17792
Author: @kjpoccia
Created: 9/26/2025
Status: ❌ Closed

Base: dev ← Head: tool-statuses

📝 Commits (1)

05656f5 tool statuses

📊 Changes

4 files changed (+162 additions, -1 deletions)

View changed files

📝 backend/open_webui/utils/middleware.py (+36 -0)
📝 backend/open_webui/utils/tools.py (+1 -0)
📝 src/lib/components/AddToolServerModal.svelte (+15 -1)
➕ src/lib/components/common/StatusMessagesConfig.svelte (+110 -0)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.

Before submitting, make sure you've checked the following:

Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

Added functionality to display status updates while an external tool is running, as well as to customize these status updates.

Added

Ability to display custom or default status updates while an external tool is running and when it has completed

Changed

None

Deprecated

None

Removed

None

Fixed

None

Security

None

Breaking Changes

None

Additional Information

Status updates can be enabled in the Admin Panel -> Settings -> External Tools -> + -> Status Messages, or through the TOOL_CONNECTION_SERVERS environment variable (TOOL_SERVER_CONNECTIONS=[{"url": "your-url", "path": "your-path", "auth_type": "your-auth-type", "key": "your-key", "config": {"enable": true}, "info": {"id": "Tool_ID", "name": "Your Tool Name", "description": "Your tool description", "status_messages": {"executing": "Executing your tool call...", "completed": "Completed tool call"}}}]
If no status messages are configured, defaults to none. If enabled with "On" in UI, will default to "Executing tool call..." and "Completed tool call"

Screenshots or Videos

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/17792 **Author:** [@kjpoccia](https://github.com/kjpoccia) **Created:** 9/26/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `tool-statuses` --- ### 📝 Commits (1) - [`05656f5`](https://github.com/open-webui/open-webui/commit/05656f56c8bdb1bebe8c5a20811c88d09eb0b6ad) tool statuses ### 📊 Changes **4 files changed** (+162 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/middleware.py` (+36 -0) 📝 `backend/open_webui/utils/tools.py` (+1 -0) 📝 `src/lib/components/AddToolServerModal.svelte` (+15 -1) ➕ `src/lib/components/common/StatusMessagesConfig.svelte` (+110 -0) </details> ### 📄 Description # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request. **Before submitting, make sure you've checked the following:** - [X] **Target branch:** Please verify that the pull request targets the `dev` branch. - [X] **Description:** Provide a concise description of the changes made in this pull request. - [X] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [X] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [X] **Testing:** Have you written and run sufficient tests to validate the changes? - [X] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [ ] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description - Added functionality to display status updates while an external tool is running, as well as to customize these status updates. ### Added - Ability to display custom or default status updates while an external tool is running and when it has completed ### Changed - None ### Deprecated - None ### Removed - None ### Fixed - None ### Security - None ### Breaking Changes - None --- ### Additional Information - Status updates can be enabled in the Admin Panel -> Settings -> External Tools -> + -> Status Messages, or through the TOOL_CONNECTION_SERVERS environment variable (TOOL_SERVER_CONNECTIONS=[{"url": "your-url", "path": "your-path", "auth_type": "your-auth-type", "key": "your-key", "config": {"enable": true}, "info": {"id": "Tool_ID", "name": "Your Tool Name", "description": "Your tool description", **"status_messages": {"executing": "Executing your tool call...", "completed": "Completed tool call"}**}}] - If no status messages are configured, defaults to none. If enabled with "On" in UI, will default to "Executing tool call..." and "Completed tool call" ### Screenshots or Videos - ![2025-09-2613-58-17-ezgif com-video-to-gif-converter](https://github.com/user-attachments/assets/640ae336-bb53-47d2-809e-ec61d053e4bc) ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-05-21 10:37:20 -05:00

GiteaMirror closed this issue

2026-05-21 10:37:23 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#128207