quickshell-docs-mcp

Live Quickshell-Dokumentation für KI-Codierungsagenten.

Ein MCP-Server, der KI-Agenten Live-Zugriff auf die offizielle Quickshell-Dokumentation bietet, damit sie aufhören, QML-API-Namen aus veralteten Trainingsdaten zu erraten.

Ebenfalls enthalten:

• Qt-Basistypen (Rectangle, RowLayout, ...) von doc.qt.io

• Offizielle Beispielkonfigurationen von quickshell-examples

• Reale Implementierungen, durchsuchbar in den Caelestia- und Noctalia-Shells

Jedes Ergebnis trägt seine Quell-URL. Wenn Implementierungen von der Dokumentation abweichen, gewinnt die Dokumentation.

Inhaltsverzeichnis

• Installation

• Konfiguration

• Werkzeuge

• Quellenhierarchie

• Referenzen

• Entwicklung

• Einschränkungen

• Lizenz

Related MCP server: Context7 MCP

Installation

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

Konfiguration

opencode (opencode.json):

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

Claude Desktop: dieselbe JSON unter claude_desktop_config.json, eingebettet in mcpServers. Für HTTP-Transport setzen Sie QUICKSHELL_DOCS_MCP_TRANSPORT=http (plus optional HOST/PORT).

Setzen Sie QUICKSHELL_DOCS_MCP_LOG=DEBUG für ausführliche Anfrageprotokollierung auf stderr. Bulk-Dokumentindizes werden auf der Festplatte gespeichert (~/.cache/quickshell-docs-mcp, 30 Tage Frische). Verschieben oder deaktivieren Sie mit QUICKSHELL_DOCS_MCP_DISK_CACHE, neu einstellen mit QUICKSHELL_DOCS_MCP_DISK_TTL_HOURS.

Werkzeuge

Seitenabruf-Werkzeuge akzeptieren version="latest" (Standard) oder eine explizite Version wie "v0.3.0". Cache-gestützte Werkzeuge akzeptieren refresh=True, um den 30-Minuten-Cache zu umgehen.

Quellenhierarchie

1. Offizielle Dokumentation (quickshell.org, doc.qt.io), maßgeblich

2. Offizielle Beispiele, als Nächstes

3. Caelestia-/Noctalia-Ergebnisse, praktische Referenzen, gekennzeichnet als real-world implementation

Referenzen

Die Daten stammen aus diesen Upstream-Quellen:

Entwicklung

Siehe CONTRIBUTING.md für Einrichtung, Arbeitsablauf und wie Sie Änderungen einreichen.

Einschränkungen

• Tiefensuche über Typseiten (include_type_pages=True) ruft jede Typseite einmal pro Maschine ab (~15s kalt, dann 30 Tage auf der Festplatte über Sitzungen hinweg zwischengespeichert; refresh=True erzwingt einen erneuten Abruf). Die einfache Namenssuche bleibt sofort.

• Beispielkonfigurationen können eine andere Quickshell-Version als Ihre anvisieren; Auflistungen enthalten ein last_modified-Datum, damit Sie ihr Alter beurteilen können.

Lizenz

MIT