langgenius/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-08-28 05:20:07 -04:00
Code Issues 775 Packages Projects Releases 10 Wiki Activity

When publishing the tool, the field description in the Output section cannot be displayed. #22136

New Issue
Closed
opened 2026-02-21 20:15:54 -05:00 by yindo · 2 comments
yindo commented 2026-02-21 20:15:54 -05:00
Owner
Copy Link
Copy Source

Originally created by @mengyunlong on GitHub (Feb 8, 2026).

Originally assigned to: @mengyunlong on GitHub.

Self Checks

  • I have read the Contributing Guide and Language Policy.
  • I have searched for existing issues search for existing issues, including closed ones.
  • I confirm that I am using English to submit this report, otherwise it will be closed.
  • Please do not modify this template :) and fill in all the required fields.

1. Is this request related to a challenge you're experiencing? Tell me about your story.

When publishing the tool, the field description in the Output section cannot be displayed.
Image

2. Additional context or comments

No response

3. Can you help us with this feature?

  • I am interested in contributing to this feature.
Originally created by @mengyunlong on GitHub (Feb 8, 2026). Originally assigned to: @mengyunlong on GitHub. ### Self Checks - [x] I have read the [Contributing Guide](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md) and [Language Policy](https://github.com/langgenius/dify/issues/1542). - [x] I have searched for existing issues [search for existing issues](https://github.com/langgenius/dify/issues), including closed ones. - [x] I confirm that I am using English to submit this report, otherwise it will be closed. - [x] Please do not modify this template :) and fill in all the required fields. ### 1. Is this request related to a challenge you're experiencing? Tell me about your story. When publishing the tool, the field description in the Output section cannot be displayed. <img width="594" height="477" alt="Image" src="https://github.com/user-attachments/assets/c3026e59-3a66-4592-af2a-00ab19807bb7" /> ### 2. Additional context or comments _No response_ ### 3. Can you help us with this feature? - [x] I am interested in contributing to this feature.
yindo added the 🐞 bug label 2026-02-21 20:15:54 -05:00
yindo closed this issue 2026-02-21 20:15:54 -05:00
yindo commented 2026-02-21 20:15:55 -05:00
Author
Owner
Copy Link
Copy Source

@dosubot[bot] commented on GitHub (Feb 8, 2026):

This is a known issue: the Output field descriptions are missing because the backend output_schema for your tool doesn't include non-empty description fields for those outputs. The frontend is already set up to display descriptions if they exist, so the fix is to make sure every output field in your tool's output_schema has a valid description string (not null or empty) in your tool definition or configuration. You can update these descriptions via your tool's YAML, API, or database entry, depending on how your tool is managed. After updating, publish the tool again and the descriptions should appear as expected in the UI. For reference, see the backend model and recent frontend handling here: tool_entities.py, use-config.ts.

If you want to contribute, a useful improvement would be to add backend or UI validation to warn when output fields are missing descriptions during tool creation or publishing. Let me know if you want more details on where to add this!

To reply, just mention @dosu.

How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other

Chat with Dosu Open in Cursor Join Discord Share on X

@dosubot[bot] commented on GitHub (Feb 8, 2026): <!-- Answer --> This is a known issue: the Output field descriptions are missing because the backend output_schema for your tool doesn't include non-empty description fields for those outputs. The frontend is already set up to display descriptions if they exist, so the fix is to make sure every output field in your tool's output_schema has a valid description string (not null or empty) in your tool definition or configuration. You can update these descriptions via your tool's YAML, API, or database entry, depending on how your tool is managed. After updating, publish the tool again and the descriptions should appear as expected in the UI. For reference, see the backend model and recent frontend handling here: [tool_entities.py](https://github.com/langgenius/dify/blob/4bd80683a436fec29f474d82bc5e69a5afc00ea6/api/core/tools/entities/tool_entities.py#L275-L411), [use-config.ts](https://github.com/langgenius/dify/pull/31779). If you want to contribute, a useful improvement would be to add backend or UI validation to warn when output fields are missing descriptions during tool creation or publishing. Let me know if you want more details on where to add this! <!-- Dosu Comment Footer --> *To reply, just mention [@dosu](https://go.dosu.dev/dosubot).* --- <sup>How did I do? [Good](https://app.dosu.dev/response-feedback/efff6393-e66d-4adb-ad5a-f8dc88abc984?feedback_type=great_response) | [Irrelevant](https://app.dosu.dev/response-feedback/efff6393-e66d-4adb-ad5a-f8dc88abc984?feedback_type=irrelevant_answer) | [Incorrect](https://app.dosu.dev/response-feedback/efff6393-e66d-4adb-ad5a-f8dc88abc984?feedback_type=incorrect_sources) | [Verbose](https://app.dosu.dev/response-feedback/efff6393-e66d-4adb-ad5a-f8dc88abc984?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/efff6393-e66d-4adb-ad5a-f8dc88abc984?feedback_type=hallucination) | [Report 🐛](https://app.dosu.dev/response-feedback/efff6393-e66d-4adb-ad5a-f8dc88abc984?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/efff6393-e66d-4adb-ad5a-f8dc88abc984?feedback_type=other)</sup> [![Chat with Dosu](https://dosu.dev/dosu-chat-badge.svg)](https://app.dosu.dev/6088a4f4-073a-43f3-b3d4-4f06fb0c05a0/ask?utm_source=github)&nbsp;[![Open in Cursor](https://dosu.dev/dosu-in-cursor.svg)](https://cursor.com/link/prompt?text=This%20is%20a%20known%20issue%3A%20the%20Output%20field%20descriptions%20are%20missing%20because%20the%20backend%20output_schema%20for%20your%20tool%20doesn%27t%20include%20non-empty%20description%20fields%20for%20those%20outputs.%20The%20frontend%20is%20already%20set%20up%20to%20display%20descriptions%20if%20they%20exist%2C%20so%20the%20fix%20is%20to%20make%20sure%20every%20output%20field%20in%20your%20tool%27s%20output_schema%20has%20a%20valid%20description%20string%20%28not%20null%20or%20empty%29%20in%20your%20tool%20definition%20or%20configuration.%20You%20can%20update%20these%20descriptions%20via%20your%20tool%27s%20YAML%2C%20API%2C%20or%20database%20entry%2C%20depending%20on%20how%20your%20tool%20is%20managed.%20After%20updating%2C%20publish%20the%20tool%20again%20and%20the%20descriptions%20should%20appear%20as%20expected%20in%20the%20UI.%20For%20reference%2C%20see%20the%20backend%20model%20and%20recent%20frontend%20handling%20here%3A%20%5Btool_entities.py%5D%28https%3A//github.com/langgenius/dify/blob/4bd80683a436fec29f474d82bc5e69a5afc00ea6/api/core/tools/entities/tool_entities.py%23L275-L411%29%2C%20%5Buse-config.ts%5D%28https%3A//github.com/langgenius/dify/pull/31779%29.%0A%0AIf%20you%20want%20to%20contribute%2C%20a%20useful%20improvement%20would%20be%20to%20add%20backend%20or%20UI%20validation%20to%20warn%20when%20output%20fields%20are%20missing%20descriptions%20during%20tool%20creation%20or%20publishing.%20Let%20me%20know%20if%20you%20want%20more%20details%20on%20where%20to%20add%20this%21)&nbsp;[![Join Discord](https://img.shields.io/badge/join-5865F2?logo=discord&logoColor=white&label=)](https://go.dosu.dev/discord-bot)&nbsp;[![Share on X](https://img.shields.io/badge/X-share-black)](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/langgenius/dify/issues/32093)
yindo commented 2026-02-21 20:15:55 -05:00
Author
Owner
Copy Link
Copy Source

@crazywoola commented on GitHub (Feb 8, 2026):

Feel free to open a PR for this. :)

@crazywoola commented on GitHub (Feb 8, 2026): Feel free to open a PR for this. :)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Knowledge Pipeline
Proposal
WIP
cloud
dependencies
feat:webapp
good first issue
outdated
performance
pull-request
Mirrored from GitHub Pull Request
 python:uv
refactor
size:L
stale
status: accepting prs
status: blocked
status: in discussion
stt & tts
vulnerablity
web
wont-fix
🌊 feat:workflow
🌚 invalid
🐞 bug
👻 feat:rag
💪 enhancement
📚 documentation
🔨 feat:tools
🙋‍♂️ question
🙏 help wanted
🤔 cant-reproduce
🤖 feat:agent
No Label 🐞 bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#22136
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?