Greptimeteam Greptimedb MCP Server

🚀 GreptimeDB-MCP-Server

GreptimeDB-MCP-Server是一個為GreptimeDB實現模型上下文協議（MCP）的服務器。它為AI助手提供了安全且結構化的接口，助力其探索和分析數據庫。通過該服務器，AI助手可以列出表格、讀取數據並執行SQL查詢，同時通過受控接口確保數據庫訪問的安全性和責任性。

🚀 快速開始

GreptimeDB-MCP-Server為AI助手與GreptimeDB之間搭建了安全橋樑。以下將介紹如何安裝、配置和使用該服務器。

📦 安裝指南

你可以使用pip命令來安裝GreptimeDB-MCP-Server：

pip install greptimedb-mcp-server

⚙️ 配置說明

你可以通過設置環境變量或使用命令行參數來配置GreptimeDB-MCP-Server。

環境變量配置

設置以下環境變量：

GREPTIMEDB_HOST=localhost    # 數據庫主機
GREPTIMEDB_PORT=4002         # 可選：數據庫端口（未指定時默認為4002）
GREPTIMEDB_USER=root
GREPTIMEDB_PASSWORD=
GREPTIMEDB_DATABASE=public

命令行參數配置

你也可以通過命令行參數進行配置：

• --host：數據庫主機
• --port：數據庫端口
• --user：數據庫用戶名
• --password：數據庫密碼
• --database：數據庫名稱

💻 使用示例

Claude Desktop 集成

你可以在Claude Desktop的配置文件中設置MCP服務器。

MacOS

配置文件位置：~/Library/Application Support/Claude/claude_desktop_config.json

Windows

配置文件位置：%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"
      }
    }
  }
}

📄 許可證

本項目採用MIT License，詳情請參見LICENSE.md文件。

👥 貢獻指南

先決條件

• 安裝Python和uv包管理器
• 安裝GreptimeDB
• 安裝MCP服務器依賴項

開發步驟

# 克隆倉庫
git clone https://github.com/GreptimeTeam/greptimedb-mcp-server.git
cd greptimedb-mcp-server

# 創建虛擬環境
python -m venv venv
source venv/bin/activate  # 或 `venv\Scripts\activate` 在Windows上  

# 安裝開發依賴項
pip install -r requirements-dev.txt

# 運行測試
pytest

調試方法

你可以使用MCP Inspector進行調試：

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

🙏 致謝

本庫的實現借鑑了以下兩個倉庫的代碼，在此表示感謝：

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