openwebui -setup

This MCP server setup guides you through adding Open Web UI related MCP tools to your environment. The repository conceptually exposes a collection of tools such as memory storage, filesystem access, time utilities, and web/API helpers that can be bridged to Open Web UI via the MCPO (MCP Protocol Bridge). With this setup, you can configure individual servers (MCP tools) and expose them through a single Open Web UI instance so your chat interface can call these tools during conversations. Typical use cases include enabling persistent memory for context, reading or writing files on your system, retrieving the current time, and performing lightweight web/API interactions from within your AI chat flows.

To use the tools, you’ll add an MCP server entry (as shown in the example) to your MCPO configuration. Once configured, start MCPO with your chosen transport (e.g., npx, docker, or uvx) and point Open Web UI to the MCPO bridge URL. After the bridge is up, you can enable the tools in Open Web UI’s Settings under Tools and begin invoking them in conversations through the chat interface.

Prerequisites:

• Node.js and npm installed (for npx-based setup)
• Access to run commands in your environment (terminal or shell)
• Optional: Docker for containerized setup

Step-by-step installation:

1. Install MCPO (if not already installed) using your preferred method (Node/npx path shown below).

2. Add the MCP server entry for the Open Web UI setup to your configuration:

   • Create or edit your MCPO config file to include: { "mcpServers": { "sonz-openwebui-mcp-setup": { "command": "npx", "args": ["-y", "@sonzentherevolution/openwebui-mcp-setup"], "env": { "OPEN_WEBUI_URL": "http://localhost:8000", "OPEN_WEBUI_API_KEY": "your-api-key" } } } }

3. Run MCPO using your preferred command path:

   • Using npx: npx -y @sonzentherevolution/openwebui-mcp-setup
   • Via uvx (Python/uv): uvx mcpo --port 8000 --api-key "your-key" -- uvx mcp-server-openwebui-setup --local-timezone=UTC
   • Docker: docker-compose up -d (in the docker directory, if provided)

4. Start your Open Web UI and ensure it can access the MCPO bridge at the configured URL (e.g., http://localhost:8000/docs).

Prerequisites include ensuring network access to the Open Web UI and having the necessary API keys configured as environment variables.

Tips and common issues:

• If your Open Web UI is not detecting tools, verify that the MCPO bridge is running and reachable at the configured URL. Check for CORS or network restrictions.
• Use the provided environment variables to securely pass the Open Web UI URL and API keys. Do not hard-code sensitive keys in your repository.
• If you encounter incompatible tool versions, pin a specific package version in your configuration (instead of latest) to ensure stability.
• For docker users, prefer docker-compose to manage both MCPO and Open Web UI services together. Ensure volumes and network aliases are correctly configured.
• When debugging, start with a single MCP server entry before expanding to multiple tools to isolate configuration issues.