Apache Iotdb MCP Server

🚀 IoTDB MCP 服務器

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

💻 使用示例

基礎用法

查詢工具（read_query）

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

架構工具（list_tables）

# 獲取數據庫中的所有表列表
# 無需輸入
# 返回: 表名數組

架構工具（describe-table）

# 查看特定表的架構信息
# 輸入:
#   - `table_name` (字符串): 要描述的表名稱
# 返回: 包含列定義（名稱和類型）的數組

📚 詳細文檔

組件

資源

該服務器沒有暴露任何資源。

提示

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

工具

該服務器提供了三個核心工具：

查詢工具

• read_query
  • 功能：執行SELECT查詢以從數據庫中讀取數據
  • 輸入:
    • query (字符串): 要執行的SELECT SQL查詢
  • 返回: 查詢結果作為對象數組

架構工具

• list_tables

  • 功能：獲取數據庫中的所有表列表
  • 輸入: 無
  • 返回: 表名數組

• describe-table

  • 功能：查看特定表的架構信息
  • 輸入:
    • table_name (字符串): 要描述的表名稱
  • 返回: 包含列定義（名稱和類型）的數組