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 (字符串): 要描述的表名称
  • 返回: 包含列定义（名称和类型）的数组