# 🔍 Using Prysm MCP Server with Open WebUI

This guide explains how to integrate the Prysm MCP Server with Open WebUI to enable powerful web scraping capabilities for AI assistants.

## ✨ Installation

1. First, make sure you have the Prysm MCP Server installed:
   ```bash
   # Recommended: Install the LLM-optimized version
   npm install -g @pinkpixel/prysm-mcp
   
   # Or install without global installation
   # You can use npx directly as shown in the configuration examples
   ```

2. Configure Open WebUI to use the Prysm MCP Server by adding it to your MCP server configuration.

## 🛠️ Configuration Options

### Basic Configuration

To add the Prysm MCP Server to Open WebUI, add the following configuration:

```json
{
  "mcpServers": {
    "prysm-scraper": {
      "command": "npx",
      "args": [
        "-y",
        "@pinkpixel/prysm-mcp"
      ]
    }
  }
}
```

### Advanced Configuration

Here's a more comprehensive configuration with multiple options:

```json
{
  "mcpServers": {
    "prysm-scraper-basic": {
      "description": "Basic web scraper with default settings",
      "command": "npx",
      "args": [
        "-y",
        "@pinkpixel/prysm-mcp"
      ]
    },
    "prysm-scraper-with-output": {
      "description": "Web scraper with custom output directory",
      "command": "sh",
      "args": [
        "-c",
        "PRYSM_OUTPUT_DIR=\"$HOME/openwebui-scrape-results\" npx -y @pinkpixel/prysm-mcp"
      ]
    },
    "prysm-local-dev": {
      "description": "For local development with cloned repo",
      "command": "node",
      "args": [
        "./dist/index.js"
      ],
      "cwd": "/path/to/local/prysm-mcp"
    }
  }
}
```

### Custom Configuration

You can create a custom configuration file for the Prysm MCP Server with Open WebUI:

```json
{
  "name": "Prysm Web Scraper",
  "description": "Advanced web scraping capabilities for Open WebUI",
  "command": "npx",
  "args": ["-y", "@pinkpixel/prysm-mcp"],
  "env": {
    "PRYSM_OUTPUT_DIR": "$HOME/openwebui-scrape-results",
    "PRYSM_IMAGE_OUTPUT_DIR": "$HOME/openwebui-scrape-results/images"
  }
}
```

For local development:

```json
{
  "name": "Prysm Web Scraper (Local)",
  "description": "Local development version of Prysm web scraper",
  "command": "node",
  "args": ["./dist/index.js"],
  "cwd": "/path/to/local/prysm-mcp",
  "env": {
    "PRYSM_OUTPUT_DIR": "$HOME/openwebui-scrape-results",
    "PRYSM_IMAGE_OUTPUT_DIR": "$HOME/openwebui-scrape-results/images"
  }
}
```

After creating this file, import it through the Open WebUI settings interface.

## ⚙️ Environment Configuration

You can customize where results are saved by setting environment variables before starting Open WebUI:

```bash
# Linux/macOS
export PRYSM_OUTPUT_DIR="/path/to/custom/directory"
export PRYSM_IMAGE_OUTPUT_DIR="/path/to/custom/image/directory"
# Then start Open WebUI

# Windows (Command Prompt)
set PRYSM_OUTPUT_DIR=C:\path\to\custom\directory
set PRYSM_IMAGE_OUTPUT_DIR=C:\path\to\custom\image\directory
# Then start Open WebUI

# Windows (PowerShell)
$env:PRYSM_OUTPUT_DIR="C:\path\to\custom\directory"
$env:PRYSM_IMAGE_OUTPUT_DIR="C:\path\to\custom\image\directory"
# Then start Open WebUI
```

By default, general results will be saved to `~/prysm-mcp/output/` and images to `~/prysm-mcp/output/images/`.

## 🚀 Available Tools

The Prysm MCP Server provides the following tools:

| Tool Name | Description | Key Parameters |
|-----------|-------------|----------------|
| scrapeFocused | Fast web scraping (fewer scrolls, main content) | `url`, `maxScrolls` (default: 5) |
| scrapeBalanced | Balanced scraping (good coverage, reasonable speed) | `url`, `maxScrolls` (default: 10), `timeout` |
| scrapeDeep | Maximum extraction (slower but thorough) | `url`, `maxScrolls` (default: 20) |
| formatResult | Format data as markdown, HTML, or JSON | `data`, `format`, `output` |

## 📝 Examples

Here are some examples of how to use the Prysm MCP tools in Open WebUI:

### Simple Scraping

Ask the assistant to scrape a webpage:

```
Please scrape https://example.com using the balanced mode
```

### Content Analysis

Ask the assistant to analyze a URL first:

```
Analyze the structure of https://example.com
```

### Custom Scraping

Ask the assistant to use specific parameters:

```
Scrape https://example.com using deep mode with maximum 15 scrolls and download images
```

### Formatting Results

Ask the assistant to format the results:

```
Format the scraped data as markdown with images included
```

You can also ask the assistant to save the formatted results to a file:

```
Format the scraped data as markdown and save it to "my-results/output.md"
```

Or specify an absolute path:

```
Format the scraped data as HTML and save it to "/home/user/documents/webpages/example.html"
```

If you don't specify a file extension, one will be added automatically based on the format.

## 💡 Tips

- For large websites, use `scrapeDeep` for thorough extraction
- For blog articles, use `scrapeFocused` for faster extraction of main content
- For product pages, use `scrapeBalanced` for a good mix of content and images
- Always analyze a URL first if you're unsure which scraping mode to use
- When saving formatted results, specify just a filename to save in the default directory
- Use the environment variable for consistent output locations across projects

## 🔒 Security Notes

- The server runs locally on your machine
- No data is sent to external servers (all processing happens locally)
- Images are only downloaded if specifically requested
- Saved files are stored on your local machine in the configured output directory

For more information, visit [Pink Pixel](https://pinkpixel.dev) or check the [GitHub repository](https://github.com/pinkpixel-dev/prysm-mcp).