AliceLynxx/Qlik-MCP-server

Qlik-MCP-server

Een Model Context Protocol (MCP) server die als interface dient tussen MCP clients en Qlik Cloud. De server maakt gebruik van de qlik-cli tool om Qlik Cloud functionaliteiten toegankelijk te maken via het MCP protocol.

Overzicht

Deze MCP server biedt een gestandaardiseerde interface voor Qlik Cloud operaties, waardoor ontwikkelaars en data analisten eenvoudig Qlik functionaliteiten kunnen integreren in hun MCP-gebaseerde workflows.

Hoofdfunctionaliteiten

• MCP Protocol Ondersteuning: Volledige implementatie van het Model Context Protocol
• Qlik CLI Integratie: Naadloze integratie met qlik-cli voor Qlik Cloud operaties
• App Management: Ondersteuning voor qlik app build en unbuild operaties
• QVF Export: Configureerbare QVF export functionaliteit met dedicated directory management
• Configureerbaar: Flexibele configuratie via environment variables of config files

Vereisten

Systeem Vereisten

• Python 3.8 of hoger
• qlik-cli geïnstalleerd en geconfigureerd
• Toegang tot Qlik Cloud tenant

Qlik CLI Setup

1. Installeer qlik-cli:

   # Via npm (aanbevolen)
   npm install -g @qlik/cli
   
   # Of download van GitHub releases
   # https://github.com/qlik-oss/qlik-cli/releases
   

2. Configureer qlik-cli:

   # Stel je Qlik Cloud context in
   qlik context create --server https://your-tenant.qlikcloud.com --server-type cloud
   
   # Authenticeer met API key
   qlik auth add --type api-key --api-key your-api-key
   

3. Test de configuratie:

   qlik app ls
   

Installatie

1. Clone de Repository

git clone https://github.com/AliceLynxx/Qlik-MCP-server.git
cd Qlik-MCP-server

2. Installeer Dependencies

pip install -r requirements.txt

3. Configuratie

Configuratie met .env-example

Voor eenvoudige configuratie, kopieer het .env-example bestand naar .env en pas de waarden aan:

cp .env-example .env

Het .env-example bestand bevat alle beschikbare configuratie-opties met uitgebreide documentatie en voorbeelden. Open het bestand om te zien welke opties beschikbaar zijn en hoe je ze kunt configureren.

Handmatige configuratie

Je kunt ook handmatig een .env bestand aanmaken in de root directory:

# Qlik CLI configuratie
QLIK_CLI_PATH=qlik
QLIK_TENANT_URL=https://your-tenant.qlikcloud.com
QLIK_API_KEY=your-api-key-here
QLIK_COMMAND_TIMEOUT=300

# QVF Export configuratie
QLIK_QVF_EXPORT_DIRECTORY=./exports

# MCP Server configuratie
MCP_SERVER_NAME=qlik-mcp-server
MCP_SERVER_VERSION=1.0.0
LOG_LEVEL=INFO
DEBUG=false

Gebruik

Server Starten

python main.py

De server start en luistert naar MCP client verbindingen.

MCP Client Configuratie

Configureer je MCP client om verbinding te maken met de Qlik-MCP-server. De exacte configuratie hangt af van je MCP client, maar over het algemeen heb je nodig:

• Server naam: qlik-mcp-server
• Protocol: MCP
• Verbinding: Lokale socket of HTTP endpoint (afhankelijk van implementatie)

Beschikbare Tools

De server biedt de volgende MCP tools:

1. qlik_app_build: Bouw een Qlik app vanuit source bestanden
2. qlik_app_unbuild: Pak een Qlik app uit naar source bestanden

Configuratie Opties

Environment Variables

Configuratie Validatie

De server valideert automatisch of qlik-cli correct is geconfigureerd bij het opstarten. Als er problemen zijn, worden deze gerapporteerd in de logs.

QVF Export Directory

De QLIK_QVF_EXPORT_DIRECTORY configuratie bepaalt waar QVF bestanden naartoe geëxporteerd worden:

• De directory wordt automatisch aangemaakt indien deze niet bestaat
• Schrijfrechten worden gevalideerd bij het opstarten
• Standaard locatie is ./exports in de project directory
• Kan worden aangepast naar elke gewenste locatie

Ontwikkeling

Project Structuur

Qlik-MCP-server/
├── main.py              # Hoofdbestand met FastMCP server
├── qlik_tools.py        # Qlik CLI integratie module
├── config.py            # Configuratie en instellingen
├── requirements.txt     # Python dependencies
├── .env-example         # Template voor environment configuratie
├── README.md           # Deze documentatie
├── project_info.txt    # Project informatie
└── project_stappen.txt # Ontwikkel roadmap

Bijdragen

1. Fork de repository
2. Maak een feature branch (git checkout -b feature/nieuwe-functie)
3. Commit je wijzigingen (git commit -am 'Voeg nieuwe functie toe')
4. Push naar de branch (git push origin feature/nieuwe-functie)
5. Maak een Pull Request

Troubleshooting

Veelvoorkomende Problemen

1. "qlik command not found"

   • Zorg ervoor dat qlik-cli is geïnstalleerd en in je PATH staat
   • Controleer de QLIK_CLI_PATH environment variable

2. "Authentication failed"

   • Controleer je API key en tenant URL
   • Zorg ervoor dat qlik-cli correct is geconfigureerd

3. "Connection timeout"

   • Verhoog de QLIK_COMMAND_TIMEOUT waarde
   • Controleer je netwerkverbinding

4. "QVF export directory not accessible"

   • Controleer of de QLIK_QVF_EXPORT_DIRECTORY bestaat en schrijfbaar is
   • Zorg ervoor dat het pad correct is opgegeven

Logs

De server gebruikt structured logging. Stel LOG_LEVEL=DEBUG in voor gedetailleerde informatie.

Licentie

Dit project is gelicenseerd onder de MIT License - zie het LICENSE bestand voor details.

Support

Voor vragen, problemen of feature requests, maak een issue aan in de GitHub repository.