Greptimeteam Greptimedb MCP Server

🚀 GreptimeDB-MCP-Server

A server implementing the Model Context Protocol (MCP) for GreptimeDB. It provides a secure and structured interface for AI assistants to explore and analyze the database, allowing them to list tables, read data, and execute SQL queries while ensuring responsible database access through a controlled interface.

🚀 Quick Start

GreptimeDB-MCP-Server is a server that implements the Model Context Protocol (MCP) for GreptimeDB, offering a secure and structured interface for AI assistants to access and analyze the database.

✨ Features

• Secure Access: Ensures responsible database access through a controlled interface.
• Comprehensive Functionality: Allows AI assistants to list tables, read data, and execute SQL queries.

📦 Installation

You can install GreptimeDB-MCP-Server using pip:

pip install greptimedb-mcp-server

📚 Documentation

Configuration

You can configure the server by setting environment variables or using command-line arguments.

Environment Variables

GREPTIMEDB_HOST=localhost    # Database host
GREPTIMEDB_PORT=4002         # Optional: Database port (default is 4002 if not specified)
GREPTIMEDB_USER=root
GREPTIMEDB_PASSWORD=
GREPTIMEDB_DATABASE=public

Command-Line Arguments

• --host: Database host
• --port: Database port
• --user: Database username
• --password: Database password
• --database: Database name

Usage

Integration with Claude Desktop

Configure the MCP server in the Claude Desktop configuration file:

MacOS

Location: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows

Location: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "greptimedb": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/greptimedb-mcp-server",
        "run",
        "-m",
        "greptimedb_mcp_server.server"
      ],
      "env": {
        "GREPTIMEDB_HOST": "localhost",
        "GREPTIMEDB_PORT": "4002",
        "GREPTIMEDB_USER": "root",
        "GREPTIMEDB_PASSWORD": "",
        "GREPTIMEDB_DATABASE": "public"
      }
    }
  }
}

📄 License

This project is under the MIT License. For details, please refer to the LICENSE.md file.

🔧 Technical Details

Contribution

Prerequisites

• Python and the uv package manager
• GreptimeDB installed
• Dependencies for the MCP server

Development

# Clone the repository
git clone https://github.com/GreptimeTeam/greptimedb-mcp-server.git
cd greptimedb-mcp-server

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # or `venv\Scripts\activate` on Windows

# Install development dependencies
pip install -r requirements-dev.txt

# Run tests
pytest

You can use the MCP Inspector for debugging:

npx @modelcontextprotocol/inspector uv \
  --directory \
  /path/to/greptimedb-mcp-server \
  run \
  -m \
  greptimedb_mcp_server.server

Acknowledgments

We would like to thank the following two repositories for their code contributions:

• ktanaka101/mcp-server-duckdb
• designcomputer/mysql_mcp_server

Thank you!