An MCP server for Timeplus.
Project description
Timeplus MCP Server
An MCP server for Timeplus.
Features
Tools
-
run_select_query- Execute SQL queries on your Timeplus cluster.
- Input:
sql(string): The SQL query to execute. - All Timeplus queries are run with
readonly = 1to ensure they are safe.
-
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.
Configuration
First, ensure you have the uv executable installed. If not, you can install it by following the instructions here.
This Python package is not published to PyPI yet. Please clone this repo and run uv sync to install the dependencies.
-
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
- On macOS:
-
Add the following:
{
"mcpServers": {
"mcp-timeplus": {
"command": "/path/to/uv",
"args": [
"run",
"--project",
"/path/to/repo/mcp-timeplus",
"--python",
"3.13",
"mcp-timeplus"
],
"env": {
"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 Timeplus service.
- Locate the command entry for
uvand replace it with the absolute path to theuvexecutable. This ensures that the correct version ofuvis used when starting the server. Also point to the absolute path to themcp-timeplusdirectory. A sample configuration:
{
"mcpServers": {
"mcp-timeplus": {
"command": "/opt/homebrew/bin/uv",
"args": [
"run",
"--project",
"/Users/jove/Dev/mcp-timeplus",
"--python",
"3.13",
"mcp-timeplus"
],
"env": {
"TIMEPLUS_HOST": "localhost",
"TIMEPLUS_PORT": "8123",
"TIMEPLUS_USER": "default",
"TIMEPLUS_PASSWORD": ""
}
}
}
}
- Restart Claude Desktop to apply the changes.
Development
-
In
test-servicesdirectory rundocker compose up -dto start a Timeplus Proton server. You can also download it viacurl https://install.timeplus.com/oss | sh, then start with./proton server. -
Add the following variables to a
.envfile in the root of the repository.
TIMEPLUS_HOST=localhost
TIMEPLUS_PORT=8123
TIMEPLUS_USER=default
TIMEPLUS_PASSWORD=
-
Run
uv syncto install the dependencies. Then dosource .venv/bin/activate. -
For easy testing, you can run
fastmcp dev mcp_timeplus/mcp_server.pyto 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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcp_timeplus-0.1.0.tar.gz.
File metadata
- Download URL: mcp_timeplus-0.1.0.tar.gz
- Upload date:
- Size: 25.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d8b87197649b77f385e99c13f9af5138378fd1641a8f95add989d7723ce706c1
|
|
| MD5 |
128c66fb9eab29977c1f4c1e8628540b
|
|
| BLAKE2b-256 |
d6e5fcdbdb4d2e3d4fc7d7880cff51adb261a294451d3fcdf5bef68a6bcad4c7
|
File details
Details for the file mcp_timeplus-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mcp_timeplus-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
61fddbaf796abb23d7b3680e168e80e8a7eb413f2b0d341ed198ed1b77733330
|
|
| MD5 |
af685a27255fb2091eccef8b106587ca
|
|
| BLAKE2b-256 |
9c3b0cb947180d97ad64dcac1a7bf71b89e827ce71d6d74f4afc29be6e3f0d84
|