quickshell-docs-mcp

AIコーディングエージェント向けのライブQuickshellドキュメント。

AIエージェントに公式のQuickshellドキュメントへのライブアクセスを提供するMCPサーバーで、古いトレーニングデータからQML API名を推測するのをやめさせます。

また、以下も含まれます:

• doc.qt.io からの Qt 基本型 (Rectangle, RowLayout, ...)

• 公式のサンプル設定は 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 も）。

詳細なリクエストログをstderrに出力するには QUICKSHELL_DOCS_MCP_LOG=DEBUG を設定します。 バルクドキュメントインデックスはディスクに保存されます（~/.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）は、マシンごとにすべての型ページを1回取得します（コールドで約15秒、その後はセッションをまたいで30日間ディスクにキャッシュされます。refresh=True で再取得を強制します）。通常の名前検索は即座に実行されます。

• サンプル設定は、あなたのQuickshellバージョンと異なる場合があります。リストには last_modified 日付が含まれているので、古さを判断できます。

ライセンス

MIT