Grounded Docs: Der Experte für aktuelle Dokumentationen Ihrer KI

Docs MCP Server löst das Problem von KI-Halluzinationen und veraltetem Wissen, indem er einen persönlichen, stets aktuellen Dokumentationsindex für Ihren KI-Programmierassistenten bereitstellt. Er ruft offizielle Dokumentationen von Websites, GitHub, npm, PyPI und lokalen Dateien ab, sodass Ihre KI die exakte Version abfragen kann, die Sie verwenden.

✨ Warum Grounded Docs MCP Server?

Die Open-Source-Alternative zu Context7, Nia und Ref.Tools.

• ✅ Aktueller Kontext: Ruft Dokumentationen bei Bedarf direkt von offiziellen Quellen ab.

• 🎯 Versionsspezifisch: Abfragen zielen auf die exakten Bibliotheksversionen in Ihrem Projekt ab.

• 💡 Reduziert Halluzinationen: Fundiert LLMs in echter Dokumentation.

• 🔒 Privat & Lokal: Läuft vollständig auf Ihrem Rechner; Ihr Code verlässt niemals Ihr Netzwerk.

• 🧩 Breite Kompatibilität: Funktioniert mit jedem MCP-kompatiblen Client (Claude, Cline, etc.).

• 📁 Mehrere Quellen: Indizieren Sie Websites, GitHub-Repositories, lokale Ordner und ZIP-Archive.

• 📄 Umfassende Dateisupport: Verarbeitet HTML, Markdown, PDF, Office-Dokumente (Word, Excel, PowerPoint), OpenDocument, RTF, EPUB, Jupyter Notebooks und 90+ Quellcode-Sprachen.

Related MCP server: Documentation Search MCP Server

📄 Unterstützte Formate

Siehe Unterstützte Formate für die vollständige Referenz inklusive MIME-Typen und Verarbeitungsdetails.

🚀 Schnellstart

CLI zuerst

Für Agenten und Skripte ist die CLI normalerweise der einfachste Weg, Grounded Docs zu nutzen.

1. Dokumentation indizieren (erfordert Node.js 22+):

npx @arabold/docs-mcp-server@latest scrape react https://react.dev/reference/react

Für Dokumentationsseiten mit Hash-Routing aktivieren Sie die Hash-Beibehaltung explizit:

npx @arabold/docs-mcp-server@latest scrape my-spa https://docs.example.com/#/guide --preserve-hashes

2. Den Index abfragen:

npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --output yaml

3. Eine einzelne Seite als Markdown abrufen:

npx @arabold/docs-mcp-server@latest fetch-url https://react.dev/reference/react/useEffect

Ausgabe-Verhalten

• Strukturierte Befehle geben bei nicht-interaktiven Ausführungen standardmäßig sauberes JSON auf stdout aus.

• Verwenden Sie --output json|yaml|toon, um ein strukturiertes Format zu wählen.

• Befehle für reinen Text wie fetch-url behalten ihre Text-Payload auf stdout.

• Diagnosen laufen über den gemeinsamen Logger und werden bei nicht-interaktiven Ausführungen nicht auf stdout ausgegeben.

• Verwenden Sie --quiet, um Nicht-Fehler-Diagnosen zu unterdrücken, oder --verbose, um Debug-Ausgaben zu aktivieren.

Agenten-Fähigkeiten

Das Verzeichnis skills/ enthält Agent Skills, die KI-Programmierassistenten beibringen, wie man die CLI verwendet — einschließlich Dokumentationssuche, Indexverwaltung und URL-Abruf.

MCP Server

Wenn Sie einen dauerhaft laufenden MCP-Endpunkt für Claude, Cline, Copilot, Gemini CLI oder andere MCP-Clients benötigen:

1. Starten Sie den Server:

npx @arabold/docs-mcp-server@latest

2. Öffnen Sie die Web-UI unter http://localhost:6280, um Dokumentationen hinzuzufügen.

3. Verbinden Sie Ihren KI-Client, indem Sie dies zu Ihren MCP-Einstellungen hinzufügen (z. B. claude_desktop_config.json):

{
  "mcpServers": {
    "docs-mcp-server": {
      "type": "sse",
      "url": "http://localhost:6280/sse"
    }
  }
}

Siehe Clients verbinden für VS Code (Cline, Roo) und andere Einrichtungsoptionen.

scrape_docs akzeptiert auch preserveHashes: true für Dokumentationsseiten, die clientseitiges Routing auf Hash-Basis verwenden. Verwenden Sie dies nur für Hash-geroutete SPAs; normale Seiten verwenden Hash-Fragmente normalerweise für Anker innerhalb der Seite.

docker run --rm \
  -v docs-mcp-data:/data \
  -v docs-mcp-config:/config \
  -p 6280:6280 \
  ghcr.io/arabold/docs-mcp-server:latest \
  --protocol http --host 0.0.0.0 --port 6280

🧠 Embedding-Modell konfigurieren (Empfohlen)

Die Verwendung eines Embedding-Modells ist optional, verbessert aber die Suchqualität durch semantische Vektorsuche erheblich.

Beispiel: OpenAI Embeddings aktivieren

OPENAI_API_KEY="sk-proj-..." npx @arabold/docs-mcp-server@latest

Siehe Embedding-Modelle für die Konfiguration von Ollama, Gemini, Azure und anderen.

📚 Dokumentation

Erste Schritte

• Installation: Detaillierte Einrichtungsanleitungen für Docker, Node.js (npx) und den Embedded-Modus.

• Clients verbinden: Wie man Claude, VS Code (Cline/Roo) und andere MCP-Clients verbindet.

• Grundlegende Verwendung: Verwendung der Web-UI, CLI und das Scrapen lokaler Dateien.

• Konfiguration: Vollständige Referenz für Konfigurationsdateien und Umgebungsvariablen.

• Unterstützte Formate: Vollständige Referenz zu Dateiformaten und MIME-Typen.

• Embedding-Modelle: Konfiguration von OpenAI, Ollama, Gemini und anderen Anbietern.

Hash-geroutete SPAs

• Verwenden Sie --preserve-hashes, MCP preserveHashes oder das Kontrollkästchen "Preserve Hash Routes" in der Web-UI nur für Dokumentationsseiten, die mit URLs wie #/guide routen.

• Wenn dies mit scrapeMode=fetch aktiviert ist, wertet der Scraper den Job automatisch auf Playwright auf, da ein einfacher Fetch clientseitige Hash-Routen nicht auswerten kann.

• Ein Refresh verwendet standardmäßig die gespeicherte preserveHashes-Einstellung; CLI/Web-Refresh-Einstiegspunkte können dies explizit überschreiben.

Schlüsselkonzepte & Architektur

• Bereitstellungsmodi: Standalone vs. Verteilt (Docker Compose).

• Authentifizierung: Absicherung Ihres Servers mit OAuth2/OIDC.

• Telemetrie: Datenerfassung mit Fokus auf Privatsphäre.

• Architektur: Detaillierter Einblick in das Systemdesign.

🤝 Mitwirken

Wir freuen uns über Beiträge! Bitte lesen Sie CONTRIBUTING.md für Entwicklungsrichtlinien und Einrichtungsanweisungen.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert. Siehe LICENSE für Details.