Clickzetta MCP Server

Clickzetta MCP Server

site icon
2025.04.15 0
Python数据库交互数据洞察数据库
Clickzetta MCP Server 是一个基于 Model Context Protocol (MCP) 的服务实现,主要用于与 Clickzetta Lakehouse 数据库进行交互。该服务允许用户通过工具运行 SQL 查询,并与一个动态更新的数据洞察备忘录进行交互。
View on GitHub

Overview

基本能力

产品定位

Clickzetta MCP Server 是一个数据库交互服务,专注于提供与 Clickzetta Lakehouse 的高效、安全的 SQL 查询和数据洞察功能。

核心功能

  1. 查询工具
  2. read_query:执行 SELECT 查询以读取数据库数据。
  3. write_query(需 --allow-write 标志):执行 INSERT、UPDATE 或 DELETE 查询。
  4. create_table(需 --allow-write 标志):在数据库中创建新表。
  5. 模式工具
  6. list_tables:获取数据库中所有表的列表。
  7. describe-table:查看特定表的列信息。
  8. 分析工具
  9. append_insight:将新的数据洞察添加到备忘录资源中。

适用场景

  1. 数据分析和报告生成。
  2. 数据库管理和维护。
  3. 数据洞察的自动收集和更新。

工具列表

  1. read_query:执行 SELECT 查询,返回查询结果。
  2. write_query:执行数据修改查询,返回受影响的行数。
  3. create_table:创建新表,返回确认信息。
  4. list_tables:列出所有表名。
  5. describe-table:查看表的列定义。
  6. append_insight:添加数据洞察到备忘录。

常见问题解答

  1. 安全性:服务默认只允许读取操作,防止 SQL 注入。
  2. 配置:需通过 .env 文件配置 Clickzetta Lakehouse 的凭据。
  3. 日志:可通过 --log_level 参数调整日志级别。

使用教程

使用依赖

  1. 确保已安装 Python 3.12.2 或更高版本。
  2. 安装 uv 工具: bash pip install uv

安装教程

  1. 克隆仓库: bash git clone https://github.com/yunqiqiliang/mcp-clickzetta-server.git cd mcp-clickzetta-server
  2. 安装包: bash uv pip install -e .
  3. 配置凭据:创建 .env 文件并填写 Clickzetta Lakehouse 的凭据。

调试方式

  1. 启动服务: bash uv run mcp_clickzetta_server
  2. 检查日志:确保服务启动成功并显示允许的工具列表。
  3. 集成到 Claude Desktop:在设置中添加 MCP 服务器配置。

示例查询

  1. 列出所有表: sql SELECT * FROM list_tables;
  2. 描述表结构: sql SELECT * FROM describe-table WHERE table_name = 'CUSTOMER_ANALYTICS';
  3. 执行自定义查询: sql SELECT customer_id, SUM(order_total) as total_spend FROM SALES.ORDERS GROUP BY customer_id ORDER BY total_spend DESC LIMIT 10;

许可证

该项目遵循 GPL-3.0 开源许可条款,请参阅 GPL-3.0 了解完整条款。