Skip to main content

An MCP server for Timeplus.

Project description

Timeplus MCP Server

PyPI - Version

An MCP server for Timeplus.

mcp-timeplus MCP server

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 = 1 to 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.

  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:

{
  "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.

  1. 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:
{
  "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": ""
      }
    }
  }
}
  1. Restart Claude Desktop to apply the changes.

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.

TIMEPLUS_HOST=localhost
TIMEPLUS_PORT=8123
TIMEPLUS_USER=default
TIMEPLUS_PASSWORD=
  1. Run uv sync to install the dependencies. Then do source .venv/bin/activate.

  2. 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.

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

mcp_timeplus-0.1.0.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_timeplus-0.1.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

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

Hashes for mcp_timeplus-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d8b87197649b77f385e99c13f9af5138378fd1641a8f95add989d7723ce706c1
MD5 128c66fb9eab29977c1f4c1e8628540b
BLAKE2b-256 d6e5fcdbdb4d2e3d4fc7d7880cff51adb261a294451d3fcdf5bef68a6bcad4c7

See more details on using hashes here.

File details

Details for the file mcp_timeplus-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_timeplus-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61fddbaf796abb23d7b3680e168e80e8a7eb413f2b0d341ed198ed1b77733330
MD5 af685a27255fb2091eccef8b106587ca
BLAKE2b-256 9c3b0cb947180d97ad64dcac1a7bf71b89e827ce71d6d74f4afc29be6e3f0d84

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page