Make it working with Timeplus Proton/Enterprise (#1)

Jove Zhong · web-flow · commit 0b8a75d2e0a4 · 2025-02-16T16:19:34.000-08:00
* Update pyproject.toml

* rename folder

* update python code

* Update README and uv
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -3,18 +3,17 @@ name: CI
 on:
   push:
     branches:
-      - main
+      - timeplus
   pull_request:
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     services:
-      clickhouse:
-        image: clickhouse/clickhouse-server:24.10
+      timeplus:
+        image: d.timeplus.com/timeplus-io/proton:latest
         ports:
-          - 9000:9000
           - 8123:8123
 
     steps:
@@ -32,10 +31,10 @@ jobs:
 
       - name: Run tests
         env:
-          CLICKHOUSE_HOST: "localhost"
-          CLICKHOUSE_PORT: "8123"
-          CLICKHOUSE_USER: "default"
-          CLICKHOUSE_PASSWORD: ""
+          TIMEPLUS_HOST: "localhost"
+          TIMEPLUS_PORT: "8123"
+          TIMEPLUS_USER: "default"
+          TIMEPLUS_PASSWORD: ""
         run: |
           uv run pytest tests
 
diff --git a/README.md b/README.md
@@ -1,28 +1,32 @@
-# ClickHouse MCP Server
-[![PyPI - Version](https://img.shields.io/pypi/v/mcp-clickhouse)](https://pypi.org/project/mcp-clickhouse)
+# Timeplus MCP Server
+[![PyPI - Version](https://img.shields.io/pypi/v/mcp-timeplus)](https://pypi.org/project/mcp-timeplus)
 
-An MCP server for ClickHouse.
+An MCP server for Timeplus.
 
-<a href="https://glama.ai/mcp/servers/yvjy4csvo1"><img width="380" height="200" src="https://glama.ai/mcp/servers/yvjy4csvo1/badge" alt="mcp-clickhouse MCP server" /></a>
+<a href="https://glama.ai/mcp/servers/yvjy4csvo1"><img width="380" height="200" src="https://glama.ai/mcp/servers/yvjy4csvo1/badge" alt="mcp-timeplus MCP server" /></a>
 
 ## Features
 
 ### Tools
 
 * `run_select_query`
-  - Execute SQL queries on your ClickHouse cluster.
+  - Execute SQL queries on your Timeplus cluster.
   - Input: `sql` (string): The SQL query to execute.
-  - All ClickHouse queries are run with `readonly = 1` to ensure they are safe.
+  - All Timeplus queries are run with `readonly = 1` to ensure they are safe.
 
 * `list_databases`
-  - List all databases on your ClickHouse cluster.
+  - List all databases on your Timeplus cluster.
 
 * `list_tables`
   - List all tables in a database.
   - Input: `database` (string): The name of the database.
 
 ## Configuration
 
+First, ensure you have the `uv` executable installed. If not, you can install it by following the instructions [here](https://docs.astral.sh/uv/).
+
+This Python package is not published to PyPI yet. Please clone this repo and run `uv sync` to install the dependencies.
+
 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`
@@ -32,73 +36,70 @@ An MCP server for ClickHouse.
 ```json
 {
   "mcpServers": {
-    "mcp-clickhouse": {
-      "command": "uv",
+    "mcp-timeplus": {
+      "command": "/path/to/uv",
       "args": [
         "run",
-        "--with",
-        "mcp-clickhouse",
+        "--project",
+        "/path/to/repo/mcp-timeplus",
         "--python",
         "3.13",
-        "mcp-clickhouse"
+        "mcp-timeplus"
       ],
       "env": {
-        "CLICKHOUSE_HOST": "<clickhouse-host>",
-        "CLICKHOUSE_PORT": "<clickhouse-port>",
-        "CLICKHOUSE_USER": "<clickhouse-user>",
-        "CLICKHOUSE_PASSWORD": "<clickhouse-password>"
+        "TIMEPLUS_HOST": "<timeplus-host>",
+        "TIMEPLUS_PORT": "<timeplus-port>",
+        "TIMEPLUS_USER": "<timeplus-user>",
+        "TIMEPLUS_PASSWORD": "<timeplus-password>"
       }
     }
   }
 }
 ```
 
-Update the environment variables to point to your own ClickHouse service.
+Update the environment variables to point to your own Timeplus service.
 
-Or, if you'd like to try it out with the [ClickHouse SQL Playground](https://sql.clickhouse.com/), you can use the following config:
+3. Locate the command entry for `uv` and replace it with the absolute path to the `uv` executable. This ensures that the correct version of `uv` is used when starting the server. Also point to the absolute path to the `mcp-timeplus` directory. A sample configuration:
 
 ```json
 {
   "mcpServers": {
-    "mcp-clickhouse": {
-      "command": "uv",
+    "mcp-timeplus": {
+      "command": "/opt/homebrew/bin/uv",
       "args": [
         "run",
-        "--with",
-        "mcp-clickhouse",
+        "--project",
+        "/Users/jove/Dev/mcp-timeplus",
         "--python",
         "3.13",
-        "mcp-clickhouse"
+        "mcp-timeplus"
       ],
       "env": {
-        "CLICKHOUSE_HOST": "sql-clickhouse.clickhouse.com",
-        "CLICKHOUSE_PORT": "8443",
-        "CLICKHOUSE_USER": "demo",
-        "CLICKHOUSE_PASSWORD": ""
+        "TIMEPLUS_HOST": "localhost",
+        "TIMEPLUS_PORT": "8123",
+        "TIMEPLUS_USER": "default",
+        "TIMEPLUS_PASSWORD": ""
       }
     }
   }
 }
 ```
 
-
-3. Locate the command entry for `uv` and replace it with the absolute path to the `uv` executable. This ensures that the correct version of `uv` is used when starting the server.
-
 4. Restart Claude Desktop to apply the changes.
 
 ## Development
 
-1. In `test-services` directory run `docker compose up -d` to start the ClickHouse cluster.
+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.
 
 ```
-CLICKHOUSE_HOST=localhost
-CLICKHOUSE_PORT=8123
-CLICKHOUSE_USER=default
-CLICKHOUSE_PASSWORD=clickhouse
+TIMEPLUS_HOST=localhost
+TIMEPLUS_PORT=8123
+TIMEPLUS_USER=default
+TIMEPLUS_PASSWORD=
 ```
 
-3. Run `uv sync` to install the dependencies. To install `uv` follow the instructions [here](https://docs.astral.sh/uv/). Then do `source .venv/bin/activate`.
+3. Run `uv sync` to install the dependencies. Then do `source .venv/bin/activate`.
 
-4. For easy testing, you can run `fastmcp dev mcp_clickhouse/mcp_server.py` to start the MCP server.
+4. For easy testing, you can run `fastmcp 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: list_databases, list_tables, run_selected_query.
diff --git a/mcp_timeplus/__init__.py b/mcp_timeplus/__init__.py
@@ -1,5 +1,5 @@
 from .mcp_server import (
-    create_clickhouse_client,
+    create_timeplus_client,
     list_databases,
     list_tables,
     run_select_query,
@@ -9,5 +9,5 @@
     "list_databases",
     "list_tables",
     "run_select_query",
-    "create_clickhouse_client",
+    "create_timeplus_client",
 ]
diff --git a/mcp_timeplus/main.py b/mcp_timeplus/main.py
diff --git a/mcp_timeplus/mcp_server.py b/mcp_timeplus/mcp_server.py
@@ -2,11 +2,11 @@
 import os
 from typing import Sequence
 
-import clickhouse_connect
+import timeplus_connect
 from dotenv import load_dotenv
 from fastmcp import FastMCP
 
-MCP_SERVER_NAME = "mcp-clickhouse"
+MCP_SERVER_NAME = "mcp-timeplus"
 
 # Configure logging
 logging.basicConfig(
@@ -17,7 +17,7 @@
 load_dotenv()
 
 deps = [
-    "clickhouse-connect",
+    "timeplus-connect",
     "python-dotenv",
     "uvicorn",
 ]
@@ -28,7 +28,7 @@
 @mcp.tool()
 def list_databases():
     logger.info("Listing all databases")
-    client = create_clickhouse_client()
+    client = create_timeplus_client()
     result = client.command("SHOW DATABASES")
     logger.info(f"Found {len(result) if isinstance(result, list) else 1} databases")
     return result
@@ -37,15 +37,15 @@ def list_databases():
 @mcp.tool()
 def list_tables(database: str, like: str = None):
     logger.info(f"Listing tables in database '{database}'")
-    client = create_clickhouse_client()
-    query = f"SHOW TABLES FROM {database}"
+    client = create_timeplus_client()
+    query = f"SHOW STREAMS FROM {database}"
     if like:
         query += f" LIKE '{like}'"
     result = client.command(query)
 
     def get_table_info(table):
         logger.info(f"Getting schema info for table {database}.{table}")
-        schema_query = f"DESCRIBE TABLE {database}.`{table}`"
+        schema_query = f"DESCRIBE STREAM {database}.`{table}`"
         schema_result = client.query(schema_query)
 
         columns = []
@@ -56,7 +56,7 @@ def get_table_info(table):
                 column_dict[col_name] = row[i]
             columns.append(column_dict)
 
-        create_table_query = f"SHOW CREATE TABLE {database}.`{table}`"
+        create_table_query = f"SHOW CREATE STREAM {database}.`{table}`"
         create_table_result = client.command(create_table_query)
 
         return {
@@ -84,7 +84,7 @@ def get_table_info(table):
 @mcp.tool()
 def run_select_query(query: str):
     logger.info(f"Executing SELECT query: {query}")
-    client = create_clickhouse_client()
+    client = create_timeplus_client()
     try:
         res = client.query(query, settings={"readonly": 1})
         column_names = res.column_names
@@ -101,14 +101,14 @@ def run_select_query(query: str):
         return f"error running query: {err}"
 
 
-def create_clickhouse_client():
-    host = os.getenv("CLICKHOUSE_HOST")
-    port = os.getenv("CLICKHOUSE_PORT")
-    username = os.getenv("CLICKHOUSE_USER")
-    logger.info(f"Creating ClickHouse client connection to {host}:{port} as {username}")
-    return clickhouse_connect.get_client(
+def create_timeplus_client():
+    host = os.getenv("TIMEPLUS_HOST")
+    port = os.getenv("TIMEPLUS_PORT")
+    username = os.getenv("TIMEPLUS_USER")
+    logger.info(f"Creating Timeplus client connection to {host}:{port} as {username}")
+    return timeplus_connect.get_client(
         host=host,
         port=port,
         username=username,
-        password=os.getenv("CLICKHOUSE_PASSWORD"),
+        password=os.getenv("TIMEPLUS_PASSWORD"),
     )
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [project]
-name = "mcp-clickhouse"
+name = "mcp-timeplus"
 version = "0.1.0"
-description = "An MCP server for ClickHouse."
+description = "An MCP server for Timeplus."
 readme = "README.md"
 license = "Apache-2.0"
 license-files = ["LICENSE"]
@@ -11,14 +11,14 @@ dependencies = [
      "python-dotenv>=1.0.1",
      "fastmcp>=0.4.0",
      "uvicorn>=0.34.0",
-     "clickhouse-connect>=0.8.0",
+     "timeplus-connect>=0.8.14",
 ]
 
 [project.scripts]
-mcp-clickhouse = "mcp_clickhouse.main:main"
+mcp-timeplus = "mcp_timeplus.main:main"
 
 [project.urls]
-Home = "https://github.com/iskakaushik/mcp-clickhouse"
+Home = "https://github.com/jovezhong/mcp-timeplus"
 
 [project.optional-dependencies]
 dev = [
@@ -27,7 +27,7 @@ dev = [
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = ["mcp_clickhouse"]
+packages = ["mcp_timeplus"]
 
 [tool.ruff]
 line-length = 100
diff --git a/test-services/docker-compose.yaml b/test-services/docker-compose.yaml
@@ -1,15 +1,15 @@
 services:
-  clickhouse:
-    image: clickhouse/clickhouse-server:latest
+  timeplus:
+    image: d.timeplus.com/timeplus-io/proton:latest
     ports:
       - "8123:8123"
-      - "9000:9000"
+      - "8463:8463"
     volumes:
-      - clickhouse-data:/var/lib/clickhouse
+      - timeplus-data:/var/lib/timeplusd
     environment:
-      - CLICKHOUSE_USER=default
-      - CLICKHOUSE_PASSWORD=clickhouse
-      - CLICKHOUSE_DB=default
+      - TIMEPLUS_USER=default
+      - TIMEPLUS_PASSWORD=
+      - TIMEPLUS_DB=default
 
 volumes:
-  clickhouse-data:
+  timeplus-data:
diff --git a/uv.lock b/uv.lock
