diff --git a/docs/features/mcp.mdx b/docs/features/mcp.mdx new file mode 100644 index 00000000..e4981b87 --- /dev/null +++ b/docs/features/mcp.mdx @@ -0,0 +1,55 @@ +--- +title: ๐Ÿ”Œ MCP (Model Context Protocol) +--- + +Open WebUI supports **MCP (Model Context Protocol)** starting in **v0.6.31**. This page shows how to enable it quickly, harden it for production, and troubleshoot common snags. + +> **Audience:** admins and power users configuring external tools + +:::info +Requires **Open WebUI v0.6.31+**. +::: + +## ๐Ÿš€ Quick start + +1. Open **โš™๏ธ Admin Settings โ†’ External Tools**. +2. Click **+ (Add Server)**. +3. Set **Type** to **MCP (Streamable HTTP)**. +4. Enter your **Server URL** and **Auth** details (OAuth 2.1, if required). +5. **Save**. If prompted, restart Open WebUI. + +You can now call tools exposed by your MCP server from Open WebUI. + +## ๐Ÿงญ When to use MCP vs OpenAPI + +:::tip +For most deployments, **OpenAPI** remains the **preferred** integration path. +::: + +Choose **OpenAPI** if you want: + +* **Enterprise readiness**: deep SSO, API gateways, audit, quotas, typed SDKs. +* **Operational resilience**: standard HTTP verbs, idempotency, caching, rich error codes. +* **Observability**: first-class tracing and policy integration. + +Choose **MCP (Streamable HTTP)** if you need: + +* A **common tool protocol** already used by your MCP servers/clients. +* **Streamed** tool events over HTTP with emerging ecosystem support. + +> You donโ€™t have to pick one: many teams expose OpenAPI internally and **wrap MCP** at the edge for specific clients. + +:::warning +Browser-based, multi-user deployments increase the surface area (CORS/CSRF, per-user isolation, reconnects). Review your orgโ€™s auth, proxy, and rate-limiting policies before exposing MCP externally. +::: + +## โ“ FAQ + +**Do you support stdio or SSE transports?** +No. Open WebUI only supports **MCP via Streamable HTTP**. + +**Is MCP considered stable here?** +Supported and improving. The broader ecosystem is still evolving; expect occasional breaking changes. + +**Can I mix OpenAPI and MCP tools?** +Yes. Many deployments do both. \ No newline at end of file