MkDocs MCP 検索サーバー

MkDocsを利用したあらゆるサイトに検索機能を提供する、モデルコンテキストプロトコル (MCP) サーバーです。このサーバーは、 Lunr.Js検索エンジンを使用した既存の MkDocs 検索実装に依存しています。

Claude デスクトップ クイックスタート

インストール手順に従ってください。Claude Desktopユーザー向けのモデルコンテキストプロトコルクイックスタートに従ってください。MCP設定ファイルに以下のセクションを追加する必要があります。

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

概要

このプロジェクトは、大規模言語モデル（LLM）が公開mkdocsドキュメントサイトを検索できるようにするMCPサーバーを実装します。lunr.jsを使用して効率的なローカル検索機能を提供し、結果を要約してユーザーに提示できるようにします。

特徴

• LLMとの統合のためのMCP準拠サーバー

• lunr.js インデックスを使用したローカル検索

• バージョン固有のドキュメント検索機能

インストール

# Install dependencies
pnpm install

# Build the project
pnpm build

使用法

サーバーは、stdio 経由で通信する MCP サーバーとして実行できます。

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

検索ツール

サーバーは、次のパラメータを持つsearch_docsツールを提供します。

• search : 検索クエリ文字列

• version : オプションのバージョン文字列（デフォルトは「latest」）

発達

建物

pnpm build

テスト

pnpm test

クロードデスクトップMCP構成

開発中は、次の構成を使用して、Claude Desktop で MCP サーバーを実行できます。

以下の構成は、Windows Subsystem for Linux (WSL) を使用して開発中に Windows の claude デスクトップで実行している様子を示しています。Mac や Linux 環境でも同様の方法で実行できます。

出力はバンドル ファイルであり、すべての依存関係がバンドルされているため、Windows にインストールされた Node で MCP サーバーを実行できます。

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

仕組み

1. サーバーは、サポートされているランタイムごとに事前に構築されたlunr.jsインデックスをロードします。

2. 検索要求を受信すると、次の処理が行われます。

   • バージョンに基づいて適切なインデックスをロードします（現在は最新に固定されています）

   • lunr.jsを使用して検索を実行します

   • 検索結果をJSONとして返します

3. LLMはこれらの結果を使用して、関連するドキュメントページを見つけることができます。

ライセンス

マサチューセッツ工科大学