Timeplus MCP Server

基本能力

产品定位

mcp-timeplus 是一个专为 Timeplus 数据库设计的 MCP 服务器，旨在通过 SQL 查询和操作 Timeplus 数据库，同时支持与 Kafka 和 Apache Iceberg 的集成。

核心功能

1. SQL 查询执行：通过 run_sql 工具执行 SQL 查询。
2. 数据库管理：通过 list_databases 和 list_tables 工具列出数据库和表。
3. Kafka 集成：通过 list_kafka_topics、explore_kafka_topic 和 create_kafka_stream 工具管理 Kafka 主题和流。
4. Apache Iceberg 连接：通过 connect_to_apache_iceberg 工具连接 Apache Iceberg 数据库。

适用场景

1. 数据查询与分析：通过 SQL 查询 Timeplus 数据库中的数据。
2. 数据流管理：管理 Kafka 主题和流，实现实时数据处理。
3. 数据集成：连接 Apache Iceberg 数据库，实现数据仓库集成。

工具列表

1. run_sql：执行 SQL 查询。
2. list_databases：列出所有数据库。
3. list_tables：列出指定数据库中的所有表。
4. list_kafka_topics：列出 Kafka 集群中的所有主题。
5. explore_kafka_topic：查看 Kafka 主题中的消息。
6. create_kafka_stream：创建流式 ETL 以保存 Kafka 消息。
7. connect_to_apache_iceberg：连接 Apache Iceberg 数据库。

常见问题解答

1. 如何启用 DDL/DML 查询：设置环境变量 TIMEPLUS_READ_ONLY 为 false。
2. 如何配置 Kafka 连接：通过 TIMEPLUS_KAFKA_CONFIG 环境变量配置 Kafka 连接参数。

使用教程

使用依赖

1. 确保已安装 uv 可执行文件。 bash curl -LsSf https://astral.sh/uv/install.sh | sh

安装教程

1. 安装 mcp-timeplus： bash pip install mcp-timeplus
2. 配置 Claude Desktop 配置文件（macOS 或 Windows）。
3. 添加 mcp-timeplus 配置并设置环境变量。
4. 重启 Claude Desktop。

调试方式

1. 启动 Timeplus Proton 服务器： bash curl https://install.timeplus.com/oss | sh ./proton server
2. 设置 .env 文件并配置环境变量。
3. 安装依赖并激活虚拟环境： bash uv sync source .venv/bin/activate
4. 启动 MCP 服务器： bash mcp dev mcp_timeplus/mcp_server.py
5. 构建 Docker 镜像： bash docker build -t mcp_timeplus .

许可证

该项目遵循 Apache-2.0 开源许可条款，请参阅 Apache-2.0 了解完整条款。