openwebui-mcp
Uses Open WebUI's Socket.IO tool loop to run tools attached to models server-side, enabling answers with real tool calls.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@openwebui-mcpAsk the project docs model to summarize the key setup steps in this repo"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
openwebui-mcp
Open WebUI MCP server built on FastMCP (standalone, v4) and the openwebui-sdk library
Lets any MCP client (Claude Desktop, Cursor, agents) ask Open WebUI models through the full tool-calling loop, not just plain chat
TheOpen WebUI SDK, the Open WebUI CLI and this MCP server are tested against Open WebUI 0.6.5
Quick start
There is no pre-configured Open WebUI identity - every caller supplies their own per request (see Authentication). Streamable HTTP is the transport to use for that:
OPENWEBUI_BASE_URL=http://localhost:8080 \
uvx openwebui-mcp --transport streamable-http --host 0.0.0.0 --port 8000Point your MCP client at http://<host>:8000/mcp?apiKey=sk-... (or send an
Authorization: Bearer header instead - see Authentication).
stdio transport (the MCP SDK default) has no per-request channel at all -
no URL, no headers. It falls back to a single, server-wideOPENWEBUI_API_KEY instead (see Authentication) - without that set,
every ask and list_models call over stdio fails with a clear error.
Prefer streamable-http or SSE for multi-user deployments, since stdio has
no way to give each caller their own identity.
Connect an MCP client
Codex CLI (~/.codex/config.toml) - register the server as owui and let
it call tools without approval:
[mcp_servers.owui]
url = "http://<host>:8000/mcp?apiKey=sk-..."
default_tools_approval_mode = "auto"Claude Desktop (claude_desktop_config.json):
{
"mcpServers": {
"openwebui": {
"type": "streamable-http",
"url": "http://<host>:8000/mcp?apiKey=sk-..."
}
}
}For SSE clients, or to run the server as a locally-spawned subprocess instead, open the collapsible options below (or see Run)
Run the server:
uvx openwebui-mcp --transport sse --host 0.0.0.0 --port 8000Claude Desktop (claude_desktop_config.json) - SSE endpoint is http://<host>:8000/sse:
{
"mcpServers": {
"openwebui": {
"type": "sse",
"url": "http://<host>:8000/sse"
}
}
}For multi-user deployments, an Authorization: Bearer header authenticates
each client to Open WebUI with their own key - see Authentication. Unlike
streamable-http, SSE does not support the apiKey query parameter.
A bare http://<host>:8000 returns 404 on initialize for both transports;
point the client URL at the full /mcp (streamable-http) or /sse (SSE)
path. rmcp and other streamable-http clients use the same URL shown in
Quick start above.
Related MCP server: mcp-model-proxy
Proactive ask skill
The repo ships a skill that makes an agent consult the ask tool eagerly
instead of only when it happens to choose to:
skills/owui-proactive-ask/SKILL.mdIt instructs the agent to call mcp__owui__ask before answering every
explicit or implicit question (advice, explanations, recommendations,
troubleshooting, follow-ups), pass relevant conversation context via
history, keep remote tools enabled (use_tools: true), and validate the OWUI
answer against local evidence before replying. It also covers failure handling
(retry, fall back, say it failed - never fake an OWUI result).
Install it with the agent skills CLI (npx skills) or manually:
# global install for Codex
npx skills add ./skills/owui-proactive-ask -g -a codex -y
# global install for Claude Code
npx skills add ./skills/owui-proactive-ask -g -a claude-code -y
# or copy the folder into your agent's skills directory
cp -r skills/owui-proactive-ask ~/.agents/skills/The skill references the tool as mcp__owui__ask, so register the MCP server
under the name owui (Codex-style clients name MCP tools
mcp__<server>__<tool>, see [mcp_servers.owui] in Quick start above).
The skill pairs with OPENWEBUI_ASK_DESCRIPTION and OPENWEBUI_INSTRUCTIONS
(see Configure): the skill makes the agent call ask, while the description
and instructions tell the model why and when.
Common usage
The typical setup is a single specialized model per use case. Model the remote side of this MCP as a domain expert and route every question to it automatically:
Create a specialized model in the Open WebUI workspace, e.g. a "my-kb-model" an expert with a knowledge base and tools attached
Match the tool description to the model - set
OPENWEBUI_ASK_DESCRIPTIONto what the model does ("ask the expert model...") so agents know when to call it (see Configure)Select the model with
OPENWEBUI_DEFAULT_MODEL=my-kb-model(the id fromlist_modelsor from the UI, listed in gray under the model name)Enforce it with
OPENWEBUI_ENFORCE_DEFAULT_MODEL=trueso everyaskcall goes to the selected model automatically, ignoring whatever model the client passes
Optionally, if you use OWUI + MCP as a knowledge base for your agent, install the Proactive ask skill to instruct the agent to consult this MCP proactively instead of only when it feels like it.
Tools
Exactly two tools are exposed
ask
Send a prompt to a model with Open WebUI tool support
prompt(required) - the user messagemodel(optional) - the model id to ask, e.g. one returned bylist_models. Omitted, the server uses the configuredOPENWEBUI_DEFAULT_MODEL; if that is also unset the call fails with an errorsystem(optional) - a system prompt leading the conversationtemperature(optional) - sampling temperature overrideuse_tools(optional, default true) - enable the tools attached to the modelhistory(optional) - prior turns[{"role": "user"|"assistant", "content": "..."}]sent beforepromptso the remote model keeps context from earlier questions
Stateless: each ask call is a fresh conversation on the remote model - it
never remembers previous calls. To carry context across questions, pass the
relevant earlier exchanges in history (e.g. your prior question and its
answer), or inline the context into prompt. Agents that keep their own
conversation log should replay the needed turns via history
To lock every call to one model regardless of what the client passes, set
OPENWEBUI_ENFORCE_DEFAULT_MODEL=true (requires OPENWEBUI_DEFAULT_MODEL);
ask then ignores the model argument entirely
To control what agents see about this tool, set OPENWEBUI_ASK_DESCRIPTION -
it replaces only the first summary line of the tool description (the text
agents read to decide how to call ask). The IMPORTANT - this MCP server is stateless block, the argument docs and the default-model guidance are always
present. Unset, the built-in summary line is used
Tools attached to the model run server-side through Open WebUI's Socket.IO
tool loop, so answers can be produced with real tool calls. Result is a struct
with answer, reasoning and tool_calls
list_models
List the models the connected Open WebUI user can see. Each entry carries the
model id, display name and the tool_ids attached to it
Authentication
Token-based. The server talks to Open WebUI as Authorization: Bearer <token>.
On streamable-http and SSE, each caller supplies their own Open WebUI identity per request - no fixed key is pre-configured on the server. Two ways to pass it, checked in this order:
An
Authorization: Bearer <token>header (works on both transports, including SSE - a header persists across the whole connection).An
apiKeyquery parameter on the MCP URL:https://<host>:8000/mcp?apiKey=sk-12345Works on streamable-http. Not SSE - the transport hands follow-up requests a bare relative URL, which drops the query string, for any compliant SSE client.
This lets multiple users share one HTTP endpoint, each authenticating to
Open WebUI as themselves - handy for clients (e.g. Claude web) that can't
set an Authorization header, via the query parameter instead. A request
with neither credential fails - there is no shared fallback identity to
silently use.
stdio transport has no per-request channel (no URL, no headers) to carry a
caller's own identity, so it falls back to a single, server-wide
OPENWEBUI_API_KEY instead. That setting is only read on stdio - it is
never consulted on streamable-http or SSE, so it can't leak into another
caller's request there. Without it set, every ask and list_models call
made over stdio fails:
OPENWEBUI_BASE_URL=http://localhost:8080
OPENWEBUI_API_KEY=sk-... # stdio only; ignored on streamable-http/SSETLS to Open WebUI
If Open WebUI is served over https with a certificate the process does not
trust (self-signed, private/Traefik CA, or a MITM proxy CA), the SDK raises
CERTIFICATE_VERIFY_FAILED. Fix by trusting the right CA, never by
silently disabling checks unless you must:
OPENWEBUI_CA_BUNDLE=/path/to/ca.pem # trust a specific PEM CA (covers JSON routes + Socket.IO tool loop)
OPENWEBUI_SSL_VERIFY=false # skip verification (JSON routes only; not recommended)The CA bundle path is applied as SSL_CERT_FILE, so all Python TLS callers
(urllib and aiohttp) pick it up. OPENWEBUI_SSL_VERIFY=false only relaxes the
urllib (JSON) routes; the Socket.IO tool loop still verifies, so prefer the CA
bundle for self-signed servers
Install
Run straight from PyPI, no local checkout needed:
uvx openwebui-mcp --helpOr install it as a tool so the openwebui-mcp command is always available:
uv tool install openwebui-mcp
openwebui-mcp --helpRequires Python 3.11+
Cloning the repo is only needed for development: uv sync (creates
.venv-docker) then uv run openwebui-mcp --help
Configure
Copy .env.example to .env or export the variables. Precedence is the first
defined env var in each alias list
Setting | Env vars (first wins) | Default |
Open WebUI URL |
| required |
Open WebUI API key (stdio only, see Authentication) |
| none |
Default model for |
| none |
Enforce default model |
|
|
|
| built-in docstring |
Server instructions |
| none |
Transport |
|
|
Chat timeout ms |
|
|
Open WebUI CA bundle |
| none |
Skip TLS verify |
|
|
Run
uv run openwebui-mcp # stdio (default) - needs OPENWEBUI_API_KEY, see Authentication
uv run openwebui-mcp --transport sse # SSE over HTTP
uv run openwebui-mcp --transport streamable-http --host 0.0.0.0 --port 8000Development
uv run pytest
uv run pyright src testsLayout
src/openwebui_mcp/server.py- FastMCP server, the two tools, TLS apply, per-request Open WebUI identity resolutionsrc/openwebui_mcp/config.py- env-driven settingssrc/openwebui_mcp/__main__.py- CLI entry pointskills/owui-proactive-ask/- agent skill that forces proactive use ofasktests/- config + server + TLS unit tests, incl. a protocol-levelcall_toolround trip
This server cannot be deployed
Maintenance
Related MCP Connectors
Model Context Protocol server for the Apideck Unified API. Connect any MCP-compatible agent framework to 100+ accounting systems, HRIS platforms, file storage providers, and more through one integration. More information https://www.apideck.com/mcp-server
Remote MCP server for supportsheep: run AI interviews and manage support content for your blog.
MCP server for Firecrawl — web search, scraping, and biomedical/arXiv paper search.
- QuallaaOAuthcom.quallaa
Talk to your public-facing AI from any MCP client — Claude, ChatGPT, Cursor, Cline, Windsurf.
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceA dual-transport MCP server that exposes your API as tools to LLM clients, supporting both stdio transport for local clients like Claude Desktop and HTTP/SSE transport for remote clients like OpenAI's Responses API.-
- AlicenseBqualityDmaintenanceA minimal local MCP server that wraps any Claude Messages API-compatible upstream into a unified ask_model tool. It enables MCP clients to interact with these models through a standard tool interface using stdio transport.18MIT
- AlicenseDqualityBmaintenanceExposes OpenWebUI's admin REST API as an MCP server, enabling administrative operations on OpenWebUI through natural language via MCP tools.1002MIT
- FlicenseNot gradedqualityDmaintenanceA standalone MCP server that exposes API endpoints as tools for AI assistants, using SSE transport.-