quickshell-docs-mcp

Живая документация Quickshell для ИИ-агентов, пишущих код.

MCP-сервер, который даёт ИИ-агентам живой доступ к официальной документации Quickshell, чтобы они перестали угадывать имена QML API по устаревшим данным из обучающей выборки.

Также включено:

• Базовые типы Qt (Rectangle, RowLayout, ...) с doc.qt.io

• Официальные примеры конфигов из quickshell-examples

• Реальные реализации, доступные для поиска по оболочкам Caelestia и Noctalia

Каждый результат содержит URL источника. Если реализации расходятся с документацией, приоритет у документации.

Содержание

• Установка

• Настройка

• Инструменты

• Иерархия источников

• Ссылки

• Разработка

• Ограничения

• Лицензия

Related MCP server: Context7 MCP

Установка

pip install quickshell-docs-mcp        # or: uvx quickshell-docs-mcp

git clone https://github.com/franklinnolasco7/quickshell-docs-mcp
cd quickshell-docs-mcp
python3 -m venv .venv && source .venv/bin/activate
pip install -e .

nix run github:franklinnolasco7/quickshell-docs-mcp

docker build -t quickshell-docs-mcp .
docker run --rm -i quickshell-docs-mcp     # speaks MCP over stdio

Настройка

opencode (opencode.json):

{
  "mcp": {
    "quickshell-docs": {
      "type": "local",
      "command": ["/absolute/path/to/quickshell-docs-mcp/.venv/bin/quickshell-docs-mcp"],
      "enabled": true
    }
  }
}

Claude Desktop: тот же JSON в claude_desktop_config.json, обёрнутый в mcpServers. Для HTTP-транспорта установите QUICKSHELL_DOCS_MCP_TRANSPORT=http (плюс опционально HOST/PORT).

Установите QUICKSHELL_DOCS_MCP_LOG=DEBUG для подробного логирования запросов в stderr. Массовые индексы документации хранятся на диске (~/.cache/quickshell-docs-mcp, свежесть 30 дней). Переместите или отключите с помощью QUICKSHELL_DOCS_MCP_DISK_CACHE, настройте повторно через QUICKSHELL_DOCS_MCP_DISK_TTL_HOURS.

Инструменты

Инструменты, получающие страницы, принимают version="latest" (по умолчанию) или явную версию, например "v0.3.0". Инструменты с кэшем принимают refresh=True для обхода 30-минутного кэша.

Иерархия источников

1. Официальная документация (quickshell.org, doc.qt.io), авторитетная

2. Официальные примеры, следующие по приоритету

3. Результаты Caelestia / Noctalia, практические ссылки с пометкой real-world implementation

Ссылки

Данные берутся из следующих вышестоящих источников:

Разработка

См. CONTRIBUTING.md по настройке, рабочему процессу и тому, как отправлять изменения.

Ограничения

• Глубокий поиск по страницам типов (include_type_pages=True) загружает каждую страницу типа один раз на машину (~15 с при холодном кэше, затем кэшируется на диске на 30 дней между сессиями; refresh=True принудительно перезагружает). Обычный поиск по имени остаётся мгновенным.

• Примеры конфигов могут быть предназначены для другой версии Quickshell, чем ваша; в списках есть дата last_modified, чтобы вы могли оценить их актуальность.

Лицензия

MIT