Skip to main content
Glama
itstedxd

PixelRAG MCP Server

by itstedxd
README.md
# PixelRAG MCP Server 🚀

An open-source **Visual Retrieval-Augmented Generation (Visual RAG)** MCP server based on [PixelRAG](https://github.com/StarTrail-org/PixelRAG) and **FastMCP**, designed for 24/7 remote hosting via SSE (Server-Sent Events) on platforms like **Railway**.

---

## 🌟 Features

- **Visual RAG Tooling**: Render web pages, PDFs, or design screenshot folders into visual tiles and query them via multimodal vision embeddings.
- **FastMCP SSE Transport**: Exposed over HTTP/HTTPS with Server-Sent Events for 24/7 remote access by Antigravity, Claude Code, Cursor, and VS Code.
- **Production Ready Docker Setup**: Includes Playwright headless Chromium pre-configured for web page screenshot rendering.

---

## 🛠️ Included Tools

1. **`index_document`**: Renders visual tiles from PDF files, image folders, or live URLs, building an indexed vector space.
2. **`query_visual_index`**: Queries screenshot tiles using natural language prompts.
3. **`health_check`**: Returns operational status of the MCP server.

---

## 🚀 Deploying to Railway

1. Click **+ New Project** $\rightarrow$ **Deploy from GitHub repo**.
2. Select `pixelrag-mcp-server`.
3. In **Settings** $\rightarrow$ **Networking**, click **Generate Domain**.
4. Use your public SSE URL:
   ```
   https://<YOUR-RAILWAY-APP>.up.railway.app/sse
   ```

---

## 🔌 Connecting to Antigravity / MCP Client

Add the following to your MCP settings file:

```json
{
  "mcpServers": {
    "pixelrag": {
      "url": "https://<YOUR-RAILWAY-APP>.up.railway.app/sse"
    }
  }
}
```