🚀 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 查询。
  • 返回: 查询结果作为对象数组。