OpenWebUI RAG MCP server

This MCP server implementation for Cline provides core knowledge base integration and retrieval functionality, enabling access to information bases and tool integrations. It serves as the backend for Cline and supports OpenWebUI integration through the Model Context Protocol.

Installation

To set up the Cline MCP server, follow these steps:

1. Make sure you have Node.js installed on your system
2. Clone the repository to your local machine
3. Install the required dependencies:

npm install

Running the Server

Development Mode

To start the server in development mode with automatic reloading:

npm run dev

The server will start and listen for incoming connections. Any changes to the source code will trigger automatic reloads.

Production Mode

For production deployment, you can build and run the server with:

npm run build
npm start

Usage

Connecting to the Server

The MCP server exposes endpoints that Cline and other compatible clients can connect to. The default connection URL is typically:

http://localhost:3000

Knowledge Base Integration

To configure knowledge bases for retrieval:

1. Set up your knowledge base configuration in the appropriate configuration file
2. Ensure the server has access permissions to the knowledge base location
3. Restart the server to apply changes

Tool Integrations

The MCP server supports various tool integrations:

• Document Processing: Process and extract information from various document formats
• Search Capabilities: Enable semantic search across knowledge bases
• Data Retrieval: Access structured and unstructured data sources

OpenWebUI Integration

To connect the MCP server with OpenWebUI:

1. Configure the OpenWebUI to point to your MCP server endpoint
2. Set up any required authentication credentials
3. Verify the connection through the OpenWebUI interface

Configuration Options

Server Configuration

The server can be configured through environment variables or a configuration file:

# Example environment variables
PORT=3000
LOG_LEVEL=info

Knowledge Base Settings

Configure knowledge base connections in your settings:

{
  "knowledgeBases": [
    {
      "id": "kb1",
      "name": "Primary Knowledge Base",
      "location": "/path/to/knowledge/base",
      "type": "vector"
    }
  ]
}

Troubleshooting

Common Issues

• Connection Errors: Verify server is running and network settings are correct
• Knowledge Base Access: Check file permissions and paths
• Performance Issues: Monitor server resources and consider scaling options

Logs

Check the server logs for detailed information about any issues:

npm run logs

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "openwebui-rag" '{"command":"npx","args":["@welkon/openwebui-server"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "openwebui-rag": {
            "command": "npx",
            "args": [
                "@welkon/openwebui-server"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "openwebui-rag": {
            "command": "npx",
            "args": [
                "@welkon/openwebui-server"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect