基本能力
产品定位
mcp-timeplus 是一个专为 Timeplus 数据库设计的 MCP 服务器,旨在通过 SQL 查询和操作 Timeplus 数据库,同时支持与 Kafka 和 Apache Iceberg 的集成。
核心功能
- SQL 查询执行:通过
run_sql
工具执行 SQL 查询。 - 数据库管理:通过
list_databases
和list_tables
工具列出数据库和表。 - Kafka 集成:通过
list_kafka_topics
、explore_kafka_topic
和create_kafka_stream
工具管理 Kafka 主题和流。 - Apache Iceberg 连接:通过
connect_to_apache_iceberg
工具连接 Apache Iceberg 数据库。
适用场景
- 数据查询与分析:通过 SQL 查询 Timeplus 数据库中的数据。
- 数据流管理:管理 Kafka 主题和流,实现实时数据处理。
- 数据集成:连接 Apache Iceberg 数据库,实现数据仓库集成。
工具列表
- run_sql:执行 SQL 查询。
- list_databases:列出所有数据库。
- list_tables:列出指定数据库中的所有表。
- list_kafka_topics:列出 Kafka 集群中的所有主题。
- explore_kafka_topic:查看 Kafka 主题中的消息。
- create_kafka_stream:创建流式 ETL 以保存 Kafka 消息。
- connect_to_apache_iceberg:连接 Apache Iceberg 数据库。
常见问题解答
- 如何启用 DDL/DML 查询:设置环境变量
TIMEPLUS_READ_ONLY
为false
。 - 如何配置 Kafka 连接:通过
TIMEPLUS_KAFKA_CONFIG
环境变量配置 Kafka 连接参数。
使用教程
使用依赖
- 确保已安装
uv
可执行文件。
bash
curl -LsSf https://astral.sh/uv/install.sh | sh
安装教程
- 安装
mcp-timeplus
:
bash
pip install mcp-timeplus - 配置 Claude Desktop 配置文件(macOS 或 Windows)。
- 添加
mcp-timeplus
配置并设置环境变量。 - 重启 Claude Desktop。
调试方式
- 启动 Timeplus Proton 服务器:
bash
curl https://install.timeplus.com/oss | sh
./proton server - 设置
.env
文件并配置环境变量。 - 安装依赖并激活虚拟环境:
bash
uv sync
source .venv/bin/activate - 启动 MCP 服务器:
bash
mcp dev mcp_timeplus/mcp_server.py - 构建 Docker 镜像:
bash
docker build -t mcp_timeplus .