Greptimedb

🚀 greptimedb-mcp-server

greptimedb-mcp-server 是為 GreptimeDB 實現的 Model Context Protocol (MCP) 服務器。該服務器為 AI 助手提供了一個安全且結構化的接口，使其能夠探索和分析數據庫。它允許助手列出表、讀取數據以及通過受控界面執行 SQL 查詢，從而實現負責任的數據庫訪問。

🚀 快速開始

greptimedb-mcp-server 為 AI 助手與 GreptimeDB 之間搭建了橋樑，讓 AI 助手能以安全、結構化的方式與數據庫交互。以下將詳細介紹其安裝、配置及使用方法。

✨ 主要特性

• list_resources：列出表格。
• read_resource：讀取表格數據。
• list_tools：列出工具。
• call_tool：執行 SQL。
• list_prompts：列出提示。
• get_prompt：根據名稱獲取提示。

📦 安裝指南

使用以下命令安裝 greptimedb-mcp-server：

pip install 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.md 文件。

👥 貢獻指南

先決條件

• 帶有 uv 包管理器的 Python。
• 安裝 GreptimeDB。
• 安裝 MCP 服務器依賴項。

開發步驟

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

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

# 安裝開發依賴項
uv sync

# 運行測試
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
• mikeskarl/mcp-prompt-templates

感謝！