PDF RAG MCP Server

Ein leistungsstarkes Dokumenten-Wissensdatenbanksystem, das PDF-Verarbeitung, Vektorspeicherung und MCP (Model Context Protocol) nutzt, um semantische Suchfunktionen für PDF-Dokumente bereitzustellen. Mit diesem System können Sie PDF-Dokumente über eine moderne Weboberfläche oder über das MCP-Protokoll hochladen, verarbeiten und abfragen, um sie mit KI-Tools wie Cursor zu integrieren.

Merkmale

• Hochladen und Verarbeiten von PDF-Dokumenten : Laden Sie PDFs hoch und extrahieren, zerlegen und vektorisieren Sie Inhalte automatisch

• Echtzeit-Verarbeitungsstatus : WebSocket-basierte Echtzeit-Statusaktualisierungen während der Dokumentverarbeitung

• Semantische Suche : Vektorbasierte semantische Suche über alle verarbeiteten Dokumente

• MCP-Protokollunterstützung : Integration mit KI-Tools wie Cursor mithilfe des Model Context Protocol

• Moderne Weboberfläche : React/Chakra-UI-Frontend für Dokumentenverwaltung und -abfragen

• Schnelles Abhängigkeitsmanagement : Verwendet UV für effizientes Python-Abhängigkeitsmanagement

Systemarchitektur

Das System besteht aus:

• FastAPI-Backend : Verarbeitet API-Anfragen, PDF-Verarbeitung und Vektorspeicherung

• React Frontend : Bietet eine benutzerfreundliche Oberfläche zur Verwaltung von Dokumenten

• Vektordatenbank : Speichert Einbettungen für die semantische Suche

• WebSocket-Server : Bietet Echtzeit-Updates zur Dokumentenverarbeitung

• MCP-Server : Stellt die Wissensdatenbank MCP-kompatiblen Clients zur Verfügung

Schnellstart

Voraussetzungen

• Python 3.8 oder höher

• uv - Schneller Python-Paketinstaller und -Resolver

• Git

• Cursor (optional, für MCP-Integration)

Schnelle Installation und Start mit uv und run.py

1. Klonen Sie das Repository:

   git clone https://github.com/yourusername/PdfRagMcpServer.git cd PdfRagMcpServer

2. Installieren Sie uv, falls Sie es noch nicht haben:

   curl -sS https://astral.sh/uv/install.sh | bash

3. Installieren Sie Abhängigkeiten mit uv:

   uv init . uv venv source .venv/bin/activate uv pip install -r backend/requirements.txt

4. Starten Sie die Anwendung mit dem praktischen Skript:

   uv run run.py

5. Greifen Sie auf die Weboberfläche unter http://localhost:8000 zu

6. Verwendung mit Cursor

Gehen Sie zu Einstellungen -> Cursor-Einstellungen -> MCP -> Neuen globalen MCP-Server hinzufügen und fügen Sie den folgenden Text in Ihre Cursor-Datei ~/.cursor/mcp.json ein. Weitere Informationen finden Sie in der Cursor-MCP-Dokumentation.

Sie können localhost auch in die Host-IP ändern, unter der Sie den Dienst bereitgestellt haben. Nachdem diese Konfiguration zum MCP-JSON hinzugefügt wurde, wird der MCP-Server auf der Cursor-MCP-Konfigurationsseite angezeigt. Aktivieren Sie ihn, um den Server zu aktivieren:

Erstellen des Frontends (für Entwickler)

Wenn Sie das Frontend neu erstellen müssen, haben Sie zwei Möglichkeiten:

Option 1: Verwenden des bereitgestellten Skripts (empfohlen)

Dieses Skript führt automatisch Folgendes aus:

• Installieren Sie Frontend-Abhängigkeiten

• Erstellen Sie das Frontend

• Kopieren Sie die Build-Ausgabe in das statische Verzeichnis des Backends

Option 2: Manueller Build-Prozess

Nachdem Sie das Frontend erstellt haben, können Sie die Anwendung mit dem Skript run.py starten.

Einfaches Produktions-Setup

Für eine Produktionsumgebung, in der die statischen Dateien bereits erstellt wurden:

1. Platzieren Sie Ihr vorgefertigtes Frontend im Verzeichnis backend/static

2. Starten Sie den Server:

   cd backend uv pip install -r requirements.txt python -m app.main

Entwicklungs-Setup (Separate Dienste)

Wenn Sie die Dienste für die Entwicklung separat ausführen möchten:

Backend

1. Navigieren Sie zum Backend-Verzeichnis:

   cd backend

2. Installieren Sie die Abhängigkeiten mit uv:

   uv pip install -r requirements.txt

3. Führen Sie den Backend-Server aus:

   python -m uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload

Frontend

1. Navigieren Sie zum Frontend-Verzeichnis:

   cd frontend

2. Installieren Sie die Abhängigkeiten:

   npm install

3. Führen Sie den Entwicklungsserver aus:

   npm run dev

Verwendung

Hochladen von Dokumenten

1. Greifen Sie auf die Weboberfläche unter http://localhost:8000 zu

2. Klicken Sie auf „Neues PDF hochladen“ und wählen Sie eine PDF-Datei aus

3. Das System verarbeitet die Datei und zeigt den Fortschritt in Echtzeit an

4. Nach der Bearbeitung steht das Dokument zur Suche zur Verfügung

Dokumente suchen

1. Verwenden Sie die Suchfunktion in der Weboberfläche

2. Oder integrieren Sie Cursor mithilfe des MCP-Protokolls

MCP-Integration mit Cursor

1. Cursor öffnen

2. Gehen Sie zu Einstellungen → KI & MCP

3. Fügen Sie einen benutzerdefinierten MCP-Server mit der URL hinzu: http://localhost:8000/mcp/v1

4. Speichern Sie die Einstellungen

5. Jetzt können Sie Ihre PDF-Wissensdatenbank direkt vom Cursor aus abfragen

Fehlerbehebung

Verbindungsprobleme

• Stellen Sie sicher, dass Port 8000 nicht von anderen Anwendungen verwendet wird

• Überprüfen Sie, ob die WebSocket-Verbindung ordnungsgemäß funktioniert

• Stellen Sie sicher, dass Ihr Browser WebSockets unterstützt

Verarbeitungsprobleme

• Überprüfen Sie, ob Ihr PDF extrahierbaren Text enthält (bei manchen gescannten PDFs ist dies möglicherweise nicht der Fall).

• Stellen Sie sicher, dass das System über ausreichend Ressourcen (Speicher und CPU) verfügt.

• Überprüfen Sie die Backend-Protokolle auf detaillierte Fehlermeldungen

Projektstruktur

Beitragen

Beiträge sind willkommen! Senden Sie gerne einen Pull Request.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der Datei LICENSE.