docs: tools and tool-ids URL parameters need the prefixed ID for tool server connections - #1386
Merged
silentoplayz merged 1 commit intoSep 9, 2026
Conversation
…nd tool-ids URL parameters
5 tasks
11 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The URL Parameters page says
toolsandtool-idstake "tool IDs" and showstool1,tool2. That works for workspace tools, whose ID is the plain ID. It does not work for tool server connections, because Open WebUI keys those asserver:mcp:<server-id>for MCP connections andserver:<server-id>for OpenAPI connections. Passing the bare connection ID activates nothing.This PR adds a note under Tool Selection that spells out both forms with an example. It also covers the fallback for an OpenAPI connection without an ID and says that an unmatched ID is not activated. It links the API reference section that already documents the
server:mcp:form. The overview table row gets one sentence so the prefix is visible at a glance.Related issue or discussion
The UI side of the same trip-up is open-webui/open-webui#29802: an unmatched ID from the URL shows a tool count of 1 with no tool selected.
Checklist
Notes for reviewers
I hit this tonight with
/?tool-ids=deepwikifor an MCP connection whose ID isdeepwiki. The chat input showed a tool count of 1, but the tool was not selected in the Integrations menu and opening the menu cleared the count.server:mcp:deepwikiis the value that parameter wants.The ID forms come from
open-webui/open-webuiat674760bfc1122e0a19fe299e05a86d1cbb528e6f: OpenAPI connections atrouters/tools.py#L117, MCP connections atrouters/tools.py#L153, and the position fallback for an OpenAPI connection with no ID atutils/tools.py#L1535-L1537.The linked anchor is the same one
docs/reference/server-side-tool-calling.mdalready uses.