Greptimedb MCP Server

🚀 greptimedb-mcp-server

The Model Context Protocol (MCP) server implemented for GreptimeDB. This server provides a secure and structured interface for AI assistants to explore and analyze the database. It allows them to list tables, read data, and execute SQL queries, ensuring responsible access to the database.

🚀 Quick Start

The greptimedb-mcp-server offers a structured interface for AI assistants to interact with GreptimeDB. Below are the steps to get started.

✨ Features

• list_resources: List tables.
• read_resource: Read table data.
• list_tools: List tools.
• call_tool: Execute SQL.
• list_prompts: List prompts.
• get_prompt: Get a prompt by name.

📦 Installation

pip install greptimedb-mcp-server

📚 Documentation

Configuration

You can set the following 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

Or use command-line arguments:

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

Usage

Claude Desktop Integration

Set 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. See the LICENSE.md file for details.

🔧 Technical Details

Contribution

Prerequisites

• Python with the uv package manager.
• GreptimeDB installed.
• MCP server dependencies.

Development

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

# Create a virtual environment
uv venv
source venv/bin/activate  # Or `venv\Scripts\activate` on Windows

# Install development dependencies
uv sync

# Run tests
pytest

Use MCP Inspector for debugging:

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

🙏 Acknowledgments

The implementation of this library borrows code from the following two repositories, and we would like to express our gratitude:

• ktanaka101/mcp-server-duckdb
• designcomputer/mysql_mcp_server
• mikeskarl/mcp-prompt-templates

Thank you to the contributors of these projects!