AI导哈

Qlik MCP服务器

作为MCP客户端和Qlik Cloud之间的接口，提供标准化的Qlik Cloud操作接口，支持应用管理和QVF导出功能。

  • by AliceLynxx
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 alicelynxx/qlik-mcp-server

使用说明

Qlik MCP服务器

一个模型上下文协议 （MCP） 服务器，作为 MCP 客户端和 Qlik Cloud 之间的接口。服务器使用 qlik-cli 工具通过 MCP 协议访问 Qlik Cloud 功能。

概述

该 MCP 服务器为 Qlik Cloud 操作提供了标准化的接口，使开发人员和数据分析师能够轻松将 Qlik 功能集成到基于 MCP 的工作流程中。

主要功能

  • MCP 协议支持模型上下文协议（Model Context Protocol）
  • CLI 集成与 qlik-cli 无缝集成，用于 Qlik Cloud 操作
  • 应用程序管理支持 qlik app build 和 unbuild 操作
  • QVF导出可配置的 QVF 导出功能，具有专用目录管理
  • 可配置：通过配置文件的环境变量进行灵活配置

要求

系统要求

  • Python 3.8 或更高版本
  • 安装并配置 qlik-cli
  • 访问Qlik云租户

Qlik CLI设置

  1. 安装者qlik-cli:

    # Via npm (aanbevolen)
npm install -g @qlik/cli

# Of download van GitHub releases
# https://github.com/qlik-oss/qlik-cli/releases

  2. 配置器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. 测试配置:

    qlik app ls

安装

1.克隆去存储库

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

2.安装者依赖关系

pip install -r requirements.txt

3. 配置

使用 .env-example 配置

为了简单的配置，复制它 .env-example 文件到 .env 并调整值：

cp .env-example .env

红细胞压积 .env-example 该文件包含所有可用的配置选项，包括详细的文档和示例。打开文件以查看可用的选项以及如何配置它们。

手动配置

你也可以手动 .env 在根目录中创建文件：

# 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

使用

服务器启动

python main.py

服务器启动并监听 MCP 客户端连接。

MCP 客户端配置

配置您的 MCP 客户端以连接到 Qlik-MCP 服务器。确切的配置取决于您的 MCP 客户端，但一般来说，您需要：

  • 服务器naam: qlik-mcp-server
  • 协议：MCP
  • 连接本地套接字或HTTP端点（取决于实现）

可用工具

服务器提供以下 MCP 工具：

  1. qlik_app_build从源文件构建Qlik应用程序
  2. qlik_app_unbuild: 将 Qlik 应用程序解压缩到源文件

配置选项

环境变量

变量 描述 Default
QLIK_CLI_PATH Qlik-CLI 可执行文件 qlik
QLIK_TENANT_URL Qlik云租户URL 无
QLIK_API_KEY 验证的 API 密钥 无
QLIK_CONTEXT_SUPPORT 启用基于上下文的身份验证 true
QLIK_CONTEXT_DIRECTORY 上下文配置目录 None （qlik-cli default）
QLIK_DEFAULT_UNBUILD_DIRECTORY Unbuild 操作的默认目录 None
QLIK_QVF_EXPORT_DIRECTORY QVF 出口操作目录 ./exports
QLIK_INCLUDE_FILE_CONTENTS 将文件内容添加到 unbuild output 。 true
QLIK_COMMAND_TIMEOUT 命令超时（秒） 300
MCP_SERVER_NAME MCP的服务器名称 qlik-mcp-server
MCP_SERVER_VERSION 服务器版本 1.0.0
LOG_LEVEL 日志（调试/信息/警告/错误） INFO
DEBUG 启用 debug 模式。 false

配置验证

服务器在启动时自动验证是否已正确配置 qlik-cli 。如果有问题，将在日志中报告。

QVF导出目录

的 QLIK_QVF_EXPORT_DIRECTORY 配置指定要导出 QVF 文件的位置：

  • 目录不存在时自动创建
  • 启动时验证写权限
  • 标准位置是 ./exports 在de项目目录中
  • 可适应任何所需位置

发展

项目结构

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

贡献

  1. 分叉仓库
  2. 创建一个功能分支（git checkout -b feature/nieuwe-functie)
  3. 提交您的更改（git commit -am 'Voeg nieuwe functie toe')
  4. 推送到分支（git push origin feature/nieuwe-functie)
  5. 创建 Pull Request

故障排除

常见问题

  1. “找不到qlik命令”

    • 确保 qlik-cli 已安装并且位于 PATH 中
    • 检查 QLIK_CLI_PATH 环境变量

  2. “身份验证失败”

    • 检查您的 API 密钥和租户 URL
    • 确保 qlik-cli 已正确配置

  3. “连接超时”

    • 增加 QLIK_COMMAND_TIMEOUT 值
    • 检查您的网络连接

  4. “QVF导出目录不可访问”

    • 检查是否 QLIK_QVF_EXPORT_DIRECTORY 存在且可写
    • 确保正确指定路径

日志

服务器使用结构化日志。设置 LOG_LEVEL=DEBUG 进入详细信息。

许可证

本项目在麻省理工学院许可证下授权 - 详情请参阅 LICENSE 文件。

支持

如有问题、问题或功能请求，请在 GitHub 仓库中创建问题。

相关 MCP