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:

{
  "mcpServers": {
    "my-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@serverless-dna/mkdocs-mcp",
        "https://your-doc-site",
        "Describe what you are enabling search for to help your AI Agent"
      ]
    }
  }
}

Ü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

# Install dependencies
pnpm install

# Build the project
pnpm build

Verwendung

Der Server kann als MCP-Server ausgeführt werden, der über stdio kommuniziert:

npx -y @serverless-dna/mkdocs-mcp https://your-doc-site.com

Suchwerkzeug

Der Server stellt ein search_docs Tool mit den folgenden Parametern bereit:

search : Die Suchabfragezeichenfolge
version : Optionale Versionszeichenfolge (standardmäßig „neueste“)

Entwicklung

Gebäude

pnpm build

Testen

pnpm test

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.

{
  "mcpServers": {
    "powertools": {
	"command": "node",
	"args": [
	  "\\\\wsl$\\Ubuntu\\home\\walmsles\\dev\\serverless-dna\\mkdocs-mcp\\dist\\index.js",
    "Search online documentation"
	]
    }
  }
}

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

This server cannot be installed

security - not tested

license - permissive license

quality - not tested

Ermöglicht Claude und anderen LLMs, jede veröffentlichte MkDocs-Dokumentationssite mithilfe der Lunr.js-Suchmaschine zu durchsuchen, sodass die KI relevante Dokumentationen für Benutzer finden und zusammenfassen kann.

Related MCP Servers

mcp-ragdocs
hannesrudolph
A
security
A
license
A
quality
An MCP server implementation that provides tools for retrieving and processing documentation through vector search, enabling AI assistants to augment their responses with relevant documentation context
Last updated -
7
62
81
TypeScript
MIT License
@sanderkooger/mcp-server-ragdocs
sanderkooger
-
security
A
license
-
quality
An MCP server implementation that provides tools for retrieving and processing documentation through vector search, enabling AI assistants to augment their responses with relevant documentation context. Uses Ollama or OpenAI to generate embeddings. Docker files included
Last updated -
19
14
TypeScript
MIT License
Claude AI Documentation Assistant
XPE-7
-
security
F
license
-
quality
An MCP server that integrates with Claude to provide smart documentation search capabilities across multiple AI/ML libraries, allowing users to retrieve and process technical information through natural language queries.
Last updated -
Python
Docs Fetch MCP Server
wolfyy970
-
security
A
license
-
quality
Enables LLMs to autonomously retrieve and explore web content by fetching pages and recursively following links to a specified depth, particularly useful for learning about topics from documentation.
Last updated -
TypeScript
MIT License

View all related MCP servers

MkDocs MCP Search Server