mkdocs MCP server
2026년 10월 27일 커밋Enables AI clients to search and retrieve content from published MkDocs sites using BM25 search over HTTP.
다른 이름 ehsanmsb/mkdocs-mcp
- 스타
- 1
- Tools
- —
- 다운로드, 30일
- —
- 최신 버전
- —
- 마지막 커밋
- 2026년 10월 27일
- 라이선스
- MIT
mkdocs MCP란?
mkdocs은(는) MCP server입니다. Enables AI clients to search and retrieve content from published MkDocs sites using BM25 search over HTTP.
프로젝트 README에서 생성된 요약
mkdocs MCP server 정보
Retrieving specific documentation sections from published MkDocs websites is what this server enables for AI clients. It works by accessing the public search_index.json file of one or more MkDocs sites via HTTP to perform BM25 searches. This allows an AI to find relevant page text and links without needing to clone a full documentation repository or manage complex authentication.
Developers set up the server locally using Python 3.14 and uv, configuring the MKDOCS_MCP_SITES environment variable with a list of site names and base URLs. Once running, the server hosts the MCP protocol at a local endpoint, which can be connected to clients through a standard JSON configuration. It is designed to handle multiple sites simultaneously by combining them into a single index, ensuring that if one site fails to refresh, the others remain available for searching.
활용 사례
- 1Search multiple documentation sitesAsk the AI to find information across several different MkDocs-based documentation platforms at once.
- 2Retrieve specific page contentRequest that the AI find and read specific sections or full page text from a public documentation site.
프로젝트의 README를 바탕으로 작성되었습니다. 모든 활용 사례는 해당 내용의 인용문과 대조하여 확인합니다.
구성
MKDOCS_MCP_SITES
| 이름 | 설명 | 유형 |
|---|---|---|
| MKDOCS_MCP_SITES | — |
자동 검사
2026년 11월 15일에 실행됨전체 보고서 →아직 인증되지 않았습니다. 서버는 80점 이상의 점수, 심각한 결함 없음, 그리고 검사에 충분한 데이터를 갖추어야 합니다. 검사 방식 · 점수를 높이기 위해 수정할 항목
- 소스 저장소 연결 및 접근 가능ehsanmsb/mkdocs-mcp is public and reachablegithub.com/ehsanmsb/mkdocs-mcp ↗통과
- 패키지가 이 저장소를 소스로 명시검사되지 않음
- 빌드 출처(Sigstore 증명)검사되지 않음
- 오픈 소스 라이선스 (OSI)MITspdx.org/licenses/MIT.html ↗통과
- 최근 1년 내 커밋 또는 릴리스Last commit or release 2026-10-27github.com/ehsanmsb/mkdocs-mcp ↗통과
- OpenSSF Scorecard검사되지 않음
- 패키지 이름이 인기 패키지와 유사하지 않음검사되지 않음
- 패키지 및 해당 종속성에 중요한 보안 권고 없음검사되지 않음
- 모델에 대한 숨겨진 지침 없음0 tool descriptions and the README read; no override phrases, credential paths or hidden characters통과
- 파괴적인 도구에 라벨 표시됨검사되지 않음
- 원격 엔드포인트가 MCP 핸드셰이크에 응답검사되지 않음
README
GitHub에서 보기
MkDocs MCP Server
A read-only Model Context Protocol server for
public MkDocs sites that publish a search index. It
searches the published search/search_index.json and returns relevant
sections, page text, and links over HTTP. It does not clone the documentation
repository or require MCP client authentication.
Quick start
Requires Python 3.14 and uv.
uv sync --locked --python 3.14
source .venv/bin/activate
export MKDOCS_MCP_SITES='[{"name":"docs","base_url":"https://docs.example.com"}]'
mkdocs-mcp
Replace the example URL with the public root of your MkDocs site. The server
fetches <base_url>/search/search_index.json on startup and serves MCP at
http://localhost:8000/mcp. If the index is elsewhere, add search_index_url
to that site's object. The index must be reachable when the server starts.
Opening / in a browser shows the server status and MCP connection URL.
Opening /mcp in a browser shows the same page; MCP clients continue to use
/mcp for protocol requests.
To search several sites through the same endpoint, add more entries to
MKDOCS_MCP_SITES. Search results identify their site and link to the original
pages:
export MKDOCS_MCP_SITES='[{"name":"atlas","base_url":"https://atlas.example.com"},{"name":"team","base_url":"https://team.example.com"}]'
The server searches all configured sites with one BM25 index. A site that fails to refresh keeps its last good content; other sites remain searchable.
For MCP clients that use an mcpServers JSON configuration:
{
"mcpServers": {
"mkdocs-docs": {
"type": "http",
"url": "http://localhost:8000/mcp"
}
}
}
Documentation
mkdocs MCP 질문
Does this server require cloning the documentation repository?
No, the server does not clone the repository; it searches the published search index instead.
How can I search multiple MkDocs sites at once?
You can search multiple sites through a single endpoint by adding multiple entries to the MKDOCS_MCP_SITES environment variable.
What happens if one of the configured sites fails to refresh?
The server will keep the last successful content for the failing site while allowing other sites to remain searchable.
Where can I find the MCP connection URL?
Opening the root URL in a browser shows the server status and the MCP connection URL.