Iotdb MCP Server TreeModel

🚀 IoTDB MCP 服務器的樹形結構模型

本項目是一個提供數據庫交互和商業智能功能的模型上下文協議（MCP）服務器實現，藉助 IoTDB 達成 SQL 查詢，為相關業務提供了便捷的數據庫操作能力。

🚀 快速開始

先決條件

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

開發步驟

# 克隆倉庫
git clone https://github.com/apache/iotdb-mcp-server.git
cd iotdb_mcp_server

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

# 安裝開發依賴項
uv sync

在 Claude 桌面的配置文件中配置 MCP 服務器

MacOS

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

Windows

文件位置: %APPDATA%/Claude/claude_desktop_config.json

⚠️ 重要提示

你可能需要將 uv 可執行文件的完整路徑放在命令字段中。你可以通過運行 which uv 在 MacOS/Linux 上或 where uv 在 Windows 上獲得此路徑。

{
  "mcpServers": {
    "iotdb": {
      "command": "uv",
      "args": [
        "--directory",
        "YOUR_REPO_PATH/src/iotdb_mcp_server",
        "run",
        "server.py"
      ],
      "env": {
        "IOTDB_HOST": "127.0.0.1",
        "IOTDB_PORT": "6667",
        "IOTDB_USER": "root",
        "IOTDB_PASSWORD": "root",
        "IOTDB_DATABASE": "test"
      }
    }
  }
}

✨ 主要特性

本服務器是一個提供數據庫交互和商業智能功能的模型上下文協議（MCP）服務器實現，通過 IoTDB 實現 SQL 查詢。

📦 安裝指南

克隆倉庫

git clone https://github.com/apache/iotdb-mcp-server.git
cd iotdb_mcp_server

創建虛擬環境

uv venv
source venv/bin/activate  # 或 `venv\Scripts\activate` 在 Windows 上

安裝開發依賴項

uv sync

💻 使用示例

基礎用法

服務器提供了三個核心工具，以下是查詢工具的使用示例：

metadata_query

# 執行 SHOW/COUNT 查詢以從數據庫讀取元數據
# 輸入:
#   query_sql (字符串): 要執行的 SHOW/COUNT SQL 查詢 
# 返回: 查詢結果作為對象數組

select_query

# 執行 SELECT 查詢以從數據庫讀取數據
# 輸入:
#   query_sql (字符串): 要執行的 SELECT SQL 查詢
# 返回: 查詢結果作為對象數組

🔧 技術細節

組件

資源

該服務器不暴露任何資源。

提示

該服務器不提供任何提示。

工具

該服務器提供了三個核心工具，這裡主要介紹查詢工具：

• metadata_query
  • 功能：執行 SHOW/COUNT 查詢以從數據庫讀取元數據。
  • 輸入:
    • query_sql (字符串): 要執行的 SHOW/COUNT SQL 查詢。
  • 返回: 查詢結果作為對象數組。
• select_query
  • 功能：執行 SELECT 查詢以從數據庫讀取數據。
  • 輸入:
    • query_sql (字符串): 要執行的 SELECT SQL 查詢。
  • 返回: 查詢結果作為對象數組。