Quickshell Mcp
Source-grounded Quickshell, QML, and Qt documentation, examples, and real-world implementations.
An MCP server that connects AI coding agents to live Quickshell, QML, and Qt documentation.
Search APIs, discover implementation patterns, explain errors, validate QML, inspect a project, run tests, and profile a live shell before your agent writes or runs code.
Why
Quickshell changes quickly, and AI coding agents can generate QML from outdated or incomplete training data. quickshell-mcp lets agents verify APIs against current documentation, find existing implementation patterns, validate generated QML, and inspect or test a project instead of guessing from memory.
Important
When sources disagree, official documentation always takes precedence.
Table of Contents
- Quick start
- What it provides
- External tools
- Knowledge sources
- Configure
- Tools
- Typical workflow
- Advanced usage
- Source priority
- Caching
- References
- Limitations
- License
Quick start
pip install quickshell-mcp # or: uvx quickshell-mcp
Then point your MCP client at it (see Configure below).
Also installable via the Model Context Protocol Registry.
Install from source
git clone https://github.com/franklinnolasco7/quickshell-mcp
cd quickshell-mcp
python3 -m venv .venv && source .venv/bin/activate
pip install -e .
Install with Nix
nix run github:franklinnolasco7/quickshell-mcp
Install with Docker
docker build -t quickshell-mcp .
docker run --rm -i quickshell-mcp # speaks MCP over stdio
What it provides
From the project's README.