github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-07-16 23:21:44 -05:00
Code Issues 2.4k Packages Projects Releases 129 Wiki Activity

[PR #22691] [CLOSED] feat: Allow HTML responses from tool results to include a custom message #81687

New Issue
Closed
opened 2026-05-13 16:03:41 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-13 16:03:41 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/22691
Author: @Haervwe
Created: 3/15/2026
Status: ❌ Closed

Base: dev ← Head: feat/custom-tool-result-message

📝 Commits (2)

  • e3ff763 feat: allow tools to return (HTMLResponse, message) tuple for custom LLM context
  • 7d830b9 Merge branch 'dev' into feat/custom-tool-result-message

📊 Changes

1 file changed (+10 additions, -3 deletions)

View changed files

📝 backend/open_webui/utils/middleware.py (+10 -3)

📄 Description

Pull Request Checklist

  • Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
  • Description: Provide a concise description of the changes made in this pull request down below.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
  • Dependencies: Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash.
  • Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to make screenshots of the feature/fix and include them in the PR description.
  • Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
  • 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?
  • Design & Architecture: Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes.
  • Git Hygiene: Keep PRs atomic (one logical change). Clean up commits and rebase on dev to ensure no unrelated commits (e.g. from main) are included. Push updates to the existing PR branch instead of closing and reopening.
  • Title 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

  • When a tool returns an HTML embed (via HTMLResponse or the tuple [(html, headers)] replaces the tool's actual return value with a hardcoded message:
    "{tool_function_name}: Embedded UI result is active and visible to the user."

This prevents tool authors from providing the LLM with specific context about the generated embed (e.g., parameters used, status, what was actually generated). This PR introduces support for an optional tuple (HTMLReturn, str | dict | list) that allows authors to override this generic message with the tuples second member, providing the LLM with actionable context while still rendering the embedded UI to the user.

See discussion:

Added

  • `Support for parsing a Tuple of (HTMLResult, str | dict | list) returns of Tools within process_tool_result to pass custom tool message response to the LLM alongside the HTML embed to the UI.

Changed

  • Updated process_tool_result (open-webui/backend/open_webui/utils/middleware.py) to fall back to the generic "Embedded UI result is active..." message only if the HTMLResult is returned alone.

Deprecated

  • None

Removed

  • None

Fixed

  • None

Security

  • None

Breaking Changes

  • None

Additional Information

  • This change is fully backwards-compatible. Existing tools that send HTMLResponse alone will continue to see the current default behavior.

Screenshots or Videos

Test on wheather tool

Test on RPG tools

The LLM can call the tool show the embed and get a helpfull message on tool output for itself for future refereces in the chat

documentation updated in PR :
https://github.com/open-webui/docs/pull/1140
for the changes

Contributor License Agreement

  • [ x] 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.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

🔄 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/22691 **Author:** [@Haervwe](https://github.com/Haervwe) **Created:** 3/15/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feat/custom-tool-result-message` --- ### 📝 Commits (2) - [`e3ff763`](https://github.com/open-webui/open-webui/commit/e3ff7635c220c3e36599a8d5ccc9c442fa58fedd) feat: allow tools to return (HTMLResponse, message) tuple for custom LLM context - [`7d830b9`](https://github.com/open-webui/open-webui/commit/7d830b97671ce9a885fe17e1476da0c39eac6715) Merge branch 'dev' into feat/custom-tool-result-message ### 📊 Changes **1 file changed** (+10 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/middleware.py` (+10 -3) </details> ### 📄 Description # Pull Request Checklist - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [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. - [x] **Documentation:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. - [x] **Dependencies:** Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash. - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to **make screenshots of the feature/fix and include them in the PR description**. - [x] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [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? - [x] **Design & Architecture:** Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes. - [x] **Git Hygiene:** Keep PRs atomic (one logical change). Clean up commits and rebase on `dev` to ensure no unrelated commits (e.g. from `main`) are included. Push updates to the existing PR branch instead of closing and reopening. - [x] **Title 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 - When a tool returns an HTML embed (via `HTMLResponse` or the tuple [(html, headers)] replaces the tool's actual return value with a hardcoded message: `"{tool_function_name}: Embedded UI result is active and visible to the user."` This prevents tool authors from providing the LLM with specific context about the generated embed (e.g., parameters used, status, what was actually generated). This PR introduces support for an optional tuple (HTMLReturn, str | dict | list) that allows authors to override this generic message with the tuples second member, providing the LLM with actionable context while still rendering the embedded UI to the user. See [discussion](https://github.com/open-webui/open-webui/discussions/22688): ### Added - `Support for parsing a Tuple of (HTMLResult, str | dict | list) returns of Tools within process_tool_result to pass custom tool message response to the LLM alongside the HTML embed to the UI. ### Changed - Updated process_tool_result (open-webui/backend/open_webui/utils/middleware.py) to fall back to the generic "Embedded UI result is active..." message only if the HTMLResult is returned alone. ### Deprecated - None ### Removed - None ### Fixed - None ### Security - None ### Breaking Changes - None --- ### Additional Information - This change is fully backwards-compatible. Existing tools that send HTMLResponse alone will continue to see the current default behavior. ### Screenshots or Videos [Test on wheather tool](https://github.com/user-attachments/assets/9a84b14b-10e0-4b4e-8083-710da731729d.gif) ![Test on RPG tools](https://github.com/user-attachments/assets/d5999d0a-ae6f-4f91-97f8-234228d7859f) The LLM can call the tool show the embed and get a helpfull message on tool output for itself for future refereces in the chat documentation updated in PR : https://github.com/open-webui/docs/pull/1140 for the changes ### Contributor License Agreement <!-- 🚨 DO NOT DELETE THE TEXT BELOW 🚨 Keep the "Contributor License Agreement" confirmation text intact. Deleting it will trigger the CLA-Bot to INVALIDATE your PR. Your PR will NOT be reviewed or merged until you check the box below confirming that you have read and agree to the terms of the CLA. --> - [ x] 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. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <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-13 16:03:41 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#81687
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?