[PR #7279] [MERGED] fix: add missing tool description #60894

New Issue

GiteaMirror · 2026-05-06T04:01:50-05:00

GiteaMirror commented

2026-05-06 04:01:50 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/7279
Author: @Luceurre
Created: 11/23/2024
Status: ✅ Merged
Merged: 11/23/2024
Merged by: @tjbck

Base: dev ← Head: fix/missing-tool-description

📝 Commits (1)

b2d3bfa feat: add description in Tool

📊 Changes

1 file changed (+32 additions, -1 deletions)

View changed files

📝 backend/open_webui/utils/tools.py (+32 -1)

📄 Description

Pull Request Checklist

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 for validating 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 cleary 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

Fix a bug in the tool management. The docstring of the functions was not used to populate the description the tool, leaving it empty.
- Added a description extraction function that given a docstring remove the :param: and :return: fields to get the function description
- Added the extracted description to the dynamically generated Pydantic model so that the description can be used by convert_pydantic_to_openai_function in LangChain

Fixed

Fix tools not having a description based on the docstring

Additional Information

Screenshots or Videos

Using the following tool:

from datetime import datetime
from typing import final
from pydantic import BaseModel


@final
class Tools:
    class Valves(BaseModel):
        pass

    class UserValves(BaseModel):
        pass

    def __init__(self):
        self.valves = self.Valves()
        self.user_valves = self.UserValves()

    def get_current_date(self) -> str:
        """
        Get the current date.
        :return: The current date as a string.
        """
        current_date = datetime.now().strftime("%A, %B %d, %Y")
        return f"Today's date is {current_date}"

    def get_current_time(self) -> str:
        """
        Get the current time.
        :return: The current time as a string.
        """
        current_time = datetime.now().strftime("%H:%M:%S")
        return f"Current Time: {current_time}"

We were getting the following specs:

{
  "specs": [
    {
      "name": "get_current_date",
      "description": "",
      "parameters": { "properties": {}, "type": "object" }
    },
    {
      "name": "get_current_time",
      "description": "",
      "parameters": { "properties": {}, "type": "object" }
    }
  ]
}

Now we are getting:

{
  "specs": [
    {
      "name": "get_current_date",
      "description": "Get the current date.",
      "parameters": { "properties": {}, "type": "object" }
    },
    {
      "name": "get_current_time",
      "description": "Get the current time.",
      "parameters": { "properties": {}, "type": "object" }
    }
  ]
}

_{🔄 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/7279 **Author:** [@Luceurre](https://github.com/Luceurre) **Created:** 11/23/2024 **Status:** ✅ Merged **Merged:** 11/23/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `fix/missing-tool-description` --- ### 📝 Commits (1) - [`b2d3bfa`](https://github.com/open-webui/open-webui/commit/b2d3bfa3a8ac330e3ed789289cf3df1768c55d07) feat: add description in Tool ### 📊 Changes **1 file changed** (+32 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/tools.py` (+32 -1) </details> ### 📄 Description # Pull Request Checklist **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. - [x] **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 for validating 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? - [x] **Prefix:** To cleary 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 - Fix a bug in the tool management. The docstring of the functions was not used to populate the description the tool, leaving it empty. - Added a description extraction function that given a docstring remove the `:param:` and `:return:` fields to get the function description - Added the extracted description to the dynamically generated Pydantic model so that the description can be used by `convert_pydantic_to_openai_function` in LangChain ### Fixed - Fix tools not having a description based on the docstring --- ### Additional Information ### Screenshots or Videos Using the following tool: ```python from datetime import datetime from typing import final from pydantic import BaseModel @final class Tools: class Valves(BaseModel): pass class UserValves(BaseModel): pass def __init__(self): self.valves = self.Valves() self.user_valves = self.UserValves() def get_current_date(self) -> str: """ Get the current date. :return: The current date as a string. """ current_date = datetime.now().strftime("%A, %B %d, %Y") return f"Today's date is {current_date}" def get_current_time(self) -> str: """ Get the current time. :return: The current time as a string. """ current_time = datetime.now().strftime("%H:%M:%S") return f"Current Time: {current_time}" ``` We were getting the following specs: ```json { "specs": [ { "name": "get_current_date", "description": "", "parameters": { "properties": {}, "type": "object" } }, { "name": "get_current_time", "description": "", "parameters": { "properties": {}, "type": "object" } } ] } ``` Now we are getting: ```json { "specs": [ { "name": "get_current_date", "description": "Get the current date.", "parameters": { "properties": {}, "type": "object" } }, { "name": "get_current_time", "description": "Get the current time.", "parameters": { "properties": {}, "type": "object" } } ] } ``` --- <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-06 04:01:50 -05:00

GiteaMirror closed this issue

2026-05-06 04:01:52 -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#60894