[PR #398] [MERGED] Add citation tool docs #497

New issue

Closed

opened 2026-10-18 14:12:32 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:12:32 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/398
Author: @taylorwilsdon
Created: 2/11/2025
Status: ✅ Merged
Merged: 2/12/2025
Merged by: @tjbck

Base: main ← Head: add_citation_tool_docs

📝 Commits (4)

4aca5ff docs: Add citation usage instructions in Tools documentation
af2d96d Add documentation for usage of the undocumented citation event emitter type with working example
06a73ac Update .gitignore
994a80d Update index.mdx

📊 Changes

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

View changed files

📝 docs/features/plugin/tools/index.mdx (+72 -3)

📄 Description

Had to reverse engineer the mechanism to send custom citations instead of just the full tool payload as a citation when interacting with a tool, so I thought it might be helpful for others to have in the documentation. This can be used to elegantly display citations, including multiple citations, in a way that the user can easily understand, interact with and follow the link to.

Before (tool with self.citation = true) - not user friendly and confusing

After - individually enumerated, easy to parse responses

_{🔄 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/docs/pull/398 **Author:** [@taylorwilsdon](https://github.com/taylorwilsdon) **Created:** 2/11/2025 **Status:** ✅ Merged **Merged:** 2/12/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `main` ← **Head:** `add_citation_tool_docs` --- ### 📝 Commits (4) - [`4aca5ff`](https://github.com/open-webui/docs/commit/4aca5ffc30418523398404d551248537bbccd77b) docs: Add citation usage instructions in Tools documentation - [`af2d96d`](https://github.com/open-webui/docs/commit/af2d96d03cc64e77ad54b667bb8823237fa873d5) Add documentation for usage of the undocumented citation event emitter type with working example - [`06a73ac`](https://github.com/open-webui/docs/commit/06a73acf6ff36e6ba04042e8084d99383837bbd8) Update .gitignore - [`994a80d`](https://github.com/open-webui/docs/commit/994a80d472c946f9e8e5c7b920f7a127cc73d6cf) Update index.mdx ### 📊 Changes **1 file changed** (+72 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `docs/features/plugin/tools/index.mdx` (+72 -3) </details> ### 📄 Description Had to reverse engineer the mechanism to send custom citations instead of just the full tool payload as a citation when interacting with a tool, so I thought it might be helpful for others to have in the documentation. This can be used to elegantly display citations, including multiple citations, in a way that the user can easily understand, interact with and follow the link to. Before (tool with self.citation = true) - not user friendly and confusing <img width="571" alt="image" src="https://github.com/user-attachments/assets/2375e195-834d-48d8-afb8-6d99aa8b078e" /> After - individually enumerated, easy to parse responses <img width="834" alt="image" src="https://github.com/user-attachments/assets/369401f9-2eb8-49f2-adb5-b2f3cc843616" /> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:12:32 +00:00