Skip to content

docs: clarify API tool and MCP support#1166

Draft
zuyua9 wants to merge 1 commit intoopen-webui:mainfrom
zuyua9:docs/api-tool-use-clarity-zuyua9
Draft

docs: clarify API tool and MCP support#1166
zuyua9 wants to merge 1 commit intoopen-webui:mainfrom
zuyua9:docs/api-tool-use-clarity-zuyua9

Conversation

@zuyua9
Copy link
Copy Markdown
Contributor

@zuyua9 zuyua9 commented Apr 5, 2026

Summary

Testing

  • arch -x86_64 /usr/bin/git -C /Users/ming/code/open-webui-docs-zuyua9 diff --check

@pr-validator-bot
Copy link
Copy Markdown

ℹ️ Documentation PR Guidelines

👋 Welcome! This is an automated message posted on all new documentation PRs to help guide our contributors. Just because this comment appeared doesn't mean you have done anything wrong!

Please ensure you're using the correct branches:

Target branch (where you're merging TO):

  • dev branch: For documentation related to upcoming Open WebUI releases (new features, new environment variables, anything dependent on unreleased versions and unreleased features/fixes/changes)
  • main branch: For content that can go live immediately (fixes, tutorials, documentation not dependent on unreleased features)

Source branch (where you're merging FROM):

  • If targeting dev, create your branch from your fork's dev branch
  • If targeting main, create your branch from your fork's main branch
  • ⚠️ Mismatched branches can and will result in unwanted file changes being included in your PR!

If your docs PR depends on a pending PR in open-webui/open-webui:

  • Convert this PR to DRAFT mode!
  • Link to the related main repo PR in your description for clarity
  • We'll review both together once the PR on the main repo is merged

Please adjust your PR target branch, source branch, and/or draft status accordingly if needed.


#### Native Mode Is Required for Tool Calling

For direct API requests, tool calling is a **Native Mode** feature. If the model is using legacy/default prompt-based function calling, Open WebUI will not inject the built-in tool surface described in the [Tools guide](/features/extensibility/plugin/tools#built-in-system-tools-nativeagentic-mode).
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning block "tool calling will not work if .."


#### Selecting Workspace / External Tools

When you need specific Open WebUI-managed tools (including external OpenAPI or MCP connections), include the relevant tool selection in the request context, typically via `tool_ids`. Those selected tool IDs are then visible to filters and other internal processing as `__metadata__.tool_ids`.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'typically'?

@Classic298 Classic298 marked this pull request as draft April 12, 2026 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants