# mkdocs-mcp

Открывает статьи и структуру MkDocs как ресурсы MCP для ИИ-ассистентов. Пригодится, когда нужно дать агенту прямой доступ к локальной документации.

- MCP-сервер · `type=mcp` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline, Zed, Gemini CLI · ★ 9
- Автор: ubaumann
- Лицензия: MIT · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/ubaumann/mkdocs-mcp
- Обновлён: 2025-09-20
- HTML: https://affpapa.org/nevibecode/mcp/mkdocs-mcp

## Что делает

Сервер переносит проект MkDocs в формат ресурсов Model Context Protocol. Из-за ограничений движка MkDocs команда `mkdocs serve` здесь не подходит: вместо неё процесс сборки и запуск MCP берёт на себя скрипт `mkdocs-mcp`.

Для запуска в системе нужен пакетный менеджер `uv`. Путь к каталогу документации задаётся через переменную окружения `MKDOCS_PROJECT_PATH` или ключ `--mkdocs-project-path`.

В файле `mkdocs.yml` обязательно объявляется плагин `mcp`. Конфигурация позволяет настроить способ именования ресурсов (`src_file`, `dst_url` или `title`), отдавать исходный Markdown вместо конвертации HTML, а также объединять статьи по папкам. Без добавления плагина в конфиг сервер документацию не отдаст.

## Требования
- Нужно: Python и uv (команды через uvx)
- Переменные окружения: `MKDOCS_PROJECT_PATH` — это ключи и токены: значения спроси у человека, в репозиторий и общие файлы не записывай.

## Установка

### Claude Code (родная платформа)

**Командой платформы**
```bash
claude mcp add mkdocs-mcp -e MKDOCS_PROJECT_PATH=<MKDOCS_PROJECT_PATH> -- uvx mkdocs-mcp
```
Вместо <…> подставьте свои значения. uvx запускает команду с именем пакета; если в README она другая — uvx --from mkdocs-mcp <команда>

### Codex

**Командой платформы**
```bash
codex mcp add mkdocs-mcp --env MKDOCS_PROJECT_PATH=<MKDOCS_PROJECT_PATH> -- uvx mkdocs-mcp
```
Вместо <…> подставьте свои значения. uvx запускает команду с именем пакета; если в README она другая — uvx --from mkdocs-mcp <команда>

### Cursor

**Файл настроек**
Файл `.cursor/mcp.json`:
```json
{
    "mcpServers": {
        "mkdocs-mcp": {
            "command": "uvx",
            "args": [
                "mkdocs-mcp"
            ],
            "env": {
                "MKDOCS_PROJECT_PATH": "<MKDOCS_PROJECT_PATH>"
            }
        }
    }
}
```
Вместо <…> подставьте свои значения. uvx запускает команду с именем пакета; если в README она другая — uvx --from mkdocs-mcp <команда>

### GitHub Copilot

**Файл настроек**
Файл `.vscode/mcp.json`:
```json
{
    "servers": {
        "mkdocs-mcp": {
            "type": "stdio",
            "command": "uvx",
            "args": [
                "mkdocs-mcp"
            ],
            "env": {
                "MKDOCS_PROJECT_PATH": "<MKDOCS_PROJECT_PATH>"
            }
        }
    }
}
```
Вместо <…> подставьте свои значения. uvx запускает команду с именем пакета; если в README она другая — uvx --from mkdocs-mcp <команда>

### Gemini CLI

**Командой платформы**
```bash
gemini mcp add -e MKDOCS_PROJECT_PATH=<MKDOCS_PROJECT_PATH> mkdocs-mcp uvx mkdocs-mcp
```
Вместо <…> подставьте свои значения. uvx запускает команду с именем пакета; если в README она другая — uvx --from mkdocs-mcp <команда>

## Когда брать
- Передать статьи базы знаний MkDocs в контекст ассистента через протокол MCP
- Настроить выдачу документации единым файлом или отдельными папками
- Использовать исходный Markdown вместо конвертации готового HTML
- Подключить локальную документацию к Claude Desktop через WSL

## Примеры запросов агенту
- Прочитай раздел об установке из ресурсов MkDocs и найди системные требования.
- Найди в подключённой документации страницу с описанием конфигурации плагина.

## Похожие
- [Reactive Resume](https://affpapa.org/nevibecode/mcp/reactive-resume.md) — MCP-сервер · ★ 44874
- [Sui Knowledge Base (kapa.ai)](https://affpapa.org/nevibecode/mcp/sui-knowledge-base-kapaai.md) — MCP-сервер · ★ 7784
- [Claude Code Ultimate Guide](https://affpapa.org/nevibecode/mcp/claude-code-ultimate-guide.md) — MCP-сервер · ★ 6237
- [Zotero MCP](https://affpapa.org/nevibecode/mcp/zotero-mcp.md) — MCP-сервер · ★ 5548
- [RevoGrid DataGrid MCP Pro](https://affpapa.org/nevibecode/mcp/revogrid-datagrid-mcp-pro.md) — MCP-сервер · ★ 3450
- [Claude Code Explorer MCP](https://affpapa.org/nevibecode/mcp/codeaashu-claude-code-explorer-mcp.md) — MCP-сервер · ★ 3409

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md