MkDocs MCP-Suchserver
Ein Model Context Protocol (MCP)-Server, der Suchfunktionen für alle MkDocs- basierten Websites bereitstellt. Dieser Server basiert auf der bestehenden MkDocs-Suchimplementierung und verwendet die Suchmaschine Lunr.Js.
Claude Desktop Schnellstart
Befolgen Sie die Installationsanweisungen. Bitte folgen Sie der Schnellstartanleitung zum Model Context Protocol für Claude Desktop-Benutzer . Sie müssen der MCP-Konfigurationsdatei einen Abschnitt wie folgt hinzufügen:
Related MCP server: Claude AI Documentation Assistant
Überblick
Dieses Projekt implementiert einen MCP-Server, der es Large Language Models (LLMs) ermöglicht, alle veröffentlichten mkdocs-Dokumentationsseiten zu durchsuchen. Es nutzt lunr.js für effiziente lokale Suchfunktionen und liefert Ergebnisse, die zusammengefasst und Benutzern präsentiert werden können.
Merkmale
MCP-kompatibler Server zur Integration mit LLMs
Lokale Suche mit lunr.js-Indizes
Versionsspezifische Dokumentationssuchfunktion
Installation
Verwendung
Der Server kann als MCP-Server ausgeführt werden, der über stdio kommuniziert:
Suchwerkzeug
Der Server stellt ein search_docs Tool mit den folgenden Parametern bereit:
search: Die Suchabfragezeichenfolgeversion: Optionale Versionszeichenfolge (standardmäßig „neueste“)
Entwicklung
Gebäude
Testen
Claude Desktop MCP-Konfiguration
Während der Entwicklung können Sie den MCP-Server mit Claude Desktop mit der folgenden Konfiguration ausführen.
Die folgende Konfiguration zeigt die Ausführung in Windows Claude Desktop während der Entwicklung mit dem Windows-Subsystem für Linux (WSL). Mac- oder Linux-Umgebungen können auf ähnliche Weise ausgeführt werden.
Die Ausgabe ist eine gebündelte Datei, die es dem unter Windows installierten Node ermöglicht, den MCP-Server auszuführen, da alle Abhängigkeiten gebündelt sind.
Wie es funktioniert
Der Server lädt vorgefertigte lunr.js-Indizes für jede unterstützte Laufzeit
Wenn eine Suchanfrage eingeht, geschieht Folgendes:
Lädt den entsprechenden Index basierend auf der Version (derzeit auf die neueste festgelegt)
Führt die Suche mit lunr.js durch
Gibt die Suchergebnisse als JSON zurück
Der LLM kann diese Ergebnisse dann verwenden, um relevante Dokumentationsseiten zu finden
Lizenz
MIT