Servidor de búsqueda MkDocs MCP

Un servidor de Protocolo de Contexto de Modelo (MCP) que proporciona funcionalidad de búsqueda para cualquier sitio web con MkDocs . Este servidor se basa en la implementación de búsqueda existente de MkDocs mediante el motor de búsqueda Lunr.Js.

Guía de inicio rápido de Claude Desktop

Siga las instrucciones de instalación. Consulte la Guía de inicio rápido del Protocolo de Contexto de Modelo para usuarios de Claude Desktop . Deberá agregar una sección al archivo de configuración de MCP como se indica a continuación:

{
  "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"
      ]
    }
  }
}

Related MCP server: MkDocs MCP Server

Descripción general

Este proyecto implementa un servidor MCP que permite a los Modelos de Lenguaje Grandes (LLM) buscar en cualquier sitio de documentación mkdocs publicada. Utiliza lunr.js para una búsqueda local eficiente y proporciona resultados que pueden resumirse y presentarse a los usuarios.

Características

• Servidor compatible con MCP para integración con LLM

• Búsqueda local utilizando índices de lunr.js

• Capacidad de búsqueda de documentación específica de la versión

Instalación

# Install dependencies
pnpm install

# Build the project
pnpm build

Uso

El servidor se puede ejecutar como un servidor MCP que se comunica a través de stdio:

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

Herramienta de búsqueda

El servidor proporciona una herramienta search_docs con los siguientes parámetros:

• search : La cadena de consulta de búsqueda

• version : cadena de versión opcional (predeterminada en 'última')

Desarrollo

Edificio

pnpm build

Pruebas

pnpm test

Configuración de MCP de Claude Desktop

Durante el desarrollo, puede ejecutar el servidor MCP con Claude Desktop utilizando la siguiente configuración.

La siguiente configuración se ejecuta en el escritorio de Windows Claude mientras se desarrolla con el Subsistema de Windows para Linux (WSL). En entornos Mac o Linux, la ejecución es similar.

La salida es un archivo incluido que permite que Node instalado en Windows ejecute el servidor MCP ya que todas las dependencias están incluidas.

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

Cómo funciona

1. El servidor carga índices lunr.js prediseñados para cada entorno de ejecución compatible

2. Cuando se recibe una solicitud de búsqueda, se realiza lo siguiente:

   • Carga el índice apropiado según la versión (actualmente fijada a la más reciente)

   • Realiza la búsqueda utilizando lunr.js

   • Devuelve los resultados de la búsqueda como JSON

3. El LLM puede luego utilizar estos resultados para encontrar páginas de documentación relevantes.

Licencia

Instituto Tecnológico de Massachusetts (MIT)