jovezhong/mcp-timeplus

An MCP server for Timeplus.
Features
Prompts
* generate_sql to give LLM more knowledge about how to query Timeplus via SQL
Tools
* run_sql
- Execute SQL queries on your Timeplus cluster.
- Input: sql (string): The SQL query to execute.
- By default, all Timeplus queries are run with readonly = 1 to ensure they are safe. If you want to run DDL or DML queries, you can set the environment variable TIMEPLUS_READ_ONLY to false.
* list_databases
- List all databases on your Timeplus cluster.
* list_tables
- List all tables in a database.
- Input: database (string): The name of the database.
* list_kafka_topics
- List all topics in a Kafka cluster
* explore_kafka_topic
- Show some messages in the Kafka topic
- Input: topic (string): The name of the topic. message_count (int): The number of messages to show, default to 1.
* create_kafka_stream
- Setup a streaming ETL in Timeplus to save the Kafka messages locally
- Input: topic (string): The name of the topic.
* connect_to_apache_iceberg
- Connect to a database based on Apache Iceberg. Currently this is only available via Timeplus Enterprise and it's planned to make it available for Timeplus Proton soon.
- Input: iceberg_db (string): The name of the Iceberg database. aws_account_id (int): The AWS account ID (12 digits). s3_bucket (string): The S3 bucket name. aws_region (string): The AWS region, default to "us-west-2". is_s3_table_bucket (bool): Whether the S3 bucket is a S3 table bucket, default to False.
Configuration
First, ensure you have the uv executable installed. If not, you can install it by following the instructions here.
1. Open the Claude Desktop configuration file located at:
- On macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- On Windows: %APPDATA%/Claude/claude_desktop_config.json
2. Add the following:
Update the environment variables to point to your own Timeplus service.
3. Restart Claude Desktop to apply the changes.
You can also try this MCP server with other MCP clients, such as 5ire.
Development
1. In test-services directory run docker compose up -d to start a Timeplus Proton server. You can also download it via curl https://install.timeplus.com/oss | sh, then start with ./proton server.
2. Add the following variables to a .env file in the root of the repository.
3. Run uv sync to install the dependencies. Then do source .venv/bin/activate.
4. For easy testing, you can run mcp dev mcp_timeplus/mcp_server.py to start the MCP server. Click the "Connect" button to connect the UI with the MCP server, then switch to the "Tools" tab to run the available tools.
5. To build the Docker image, run docker build -t mcp_timeplus ..
Environment Variables
The following environment variables are used to configure the Timeplus connection:
Required Variables
* TIMEPLUS_HOST: The hostname of your Timeplus server
* TIMEPLUS_USER: The username for authentication