MkDocs MCP 검색 서버

MkDocs 기반 사이트에 검색 기능을 제공하는 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이 서버는 Lunr.Js 검색 엔진을 사용하는 기존 MkDocs 검색 구현을 기반으로 합니다.

클로드 데스크톱 빠른 시작

설치 지침을 따르세요. Claude Desktop 사용자를 위한 Model Context Protocol 빠른 시작을 참조하세요. MCP 구성 파일에 다음과 같이 섹션을 추가해야 합니다.

지엑스피1

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 : 선택 버전 문자열(기본값은 '최신')

개발

건물

pnpm build

테스트

pnpm test

Claude Desktop MCP 구성

개발 중에는 다음 구성을 사용하여 Claude Desktop과 함께 MCP 서버를 실행할 수 있습니다.

아래 구성은 Windows Subsystem for Linux(WSL)를 사용하여 개발하는 동안 Windows Claude Desktop에서 실행하는 방법을 보여줍니다. 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은 이러한 결과를 사용하여 관련 문서 페이지를 찾을 수 있습니다.

특허

MIT