quickshell-docs-mcp

Documentación en vivo de Quickshell para agentes de programación de IA.

Un servidor MCP que ofrece a los agentes de IA acceso en vivo a la documentación oficial de Quickshell, para que dejen de adivinar los nombres de las API de QML a partir de datos de entrenamiento obsoletos.

También se incluye:

• Tipos base de Qt (Rectangle, RowLayout, ...) de doc.qt.io

• Configuraciones de ejemplo oficiales de quickshell-examples

• Implementaciones del mundo real, buscables en los shells Caelestia y Noctalia

Cada resultado incluye la URL de su fuente. Cuando las implementaciones entran en conflicto con la documentación, gana la documentación.

Tabla de contenidos

• Instalación

• Configuración

• Herramientas

• Jerarquía de fuentes

• Referencias

• Desarrollo

• Limitaciones

• Licencia

Related MCP server: Context7 MCP

Instalación

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

Configuración

opencode (opencode.json):

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

Claude Desktop: el mismo JSON en claude_desktop_config.json, envuelto en mcpServers. Para el transporte HTTP, establece QUICKSHELL_DOCS_MCP_TRANSPORT=http (además de HOST/PORT opcionales).

Establece QUICKSHELL_DOCS_MCP_LOG=DEBUG para un registro detallado de solicitudes en stderr. Los índices de documentación completos se conservan en disco (~/.cache/quickshell-docs-mcp, con una vigencia de 30 días). Puedes reubicar o desactivar esta caché con QUICKSHELL_DOCS_MCP_DISK_CACHE y reajustar su vigencia con QUICKSHELL_DOCS_MCP_DISK_TTL_HOURS.

Herramientas

Las herramientas de obtención de páginas aceptan version="latest" (por defecto) o una versión explícita como "v0.3.0". Las herramientas respaldadas por caché aceptan refresh=True para omitir la caché de 30 minutos.

Jerarquía de fuentes

1. Documentación oficial (quickshell.org, doc.qt.io), autoritativa

2. Ejemplos oficiales, en segundo lugar

3. Resultados de Caelestia / Noctalia, referencias prácticas etiquetadas como real-world implementation

Referencias

Los datos proceden de estas fuentes de origen:

Desarrollo

Consulta CONTRIBUTING.md para la configuración inicial, el flujo de trabajo y cómo enviar cambios.

Limitaciones

• La búsqueda profunda de páginas de tipos (include_type_pages=True) descarga cada página de tipos una vez por máquina (unos 15 s en frío; después queda en caché en disco durante 30 días entre sesiones; refresh=True fuerza una nueva descarga). La búsqueda simple por nombre sigue siendo instantánea.

• Las configuraciones de ejemplo pueden apuntar a una versión de Quickshell distinta de la tuya; los listados incluyen una fecha last_modified para que puedas evaluar su antigüedad.

Licencia

MIT