Skip to main content
Glama
IoTDB MCP Server

IoTDB MCP Server

Official
by apache

IoTDB MCP-Server

Schmiedeabzeichen

Überblick

Eine Model Context Protocol (MCP)-Serverimplementierung, die Datenbankinteraktion und Business Intelligence-Funktionen über IoTDB ermöglicht. Dieser Server ermöglicht die Ausführung von SQL-Abfragen.

Related MCP server: XiYan MCP Server

Komponenten

Ressourcen

Der Server stellt keine Ressourcen bereit.

Eingabeaufforderungen

Der Server gibt keine Eingabeaufforderungen aus.

Werkzeuge

Der Server bietet verschiedene Tools für das IoTDB-Baummodell und das Tabellenmodell. Sie können zwischen diesen wählen, indem Sie die Konfiguration "IOTDB_SQL_DIALECT" auf "Baum" oder "Tabelle" setzen.

Baummodell

  • metadata_query

    • Führen Sie SHOW/COUNT-Abfragen aus, um Metadaten aus der Datenbank zu lesen

    • Eingang:

      • query_sql (Zeichenfolge): Die auszuführende SHOW/COUNT-SQL-Abfrage

    • Gibt zurück: Abfrageergebnisse als Array von Objekten

  • select_query

    • Führen Sie SELECT-Abfragen aus, um Daten aus der Datenbank zu lesen

    • Eingang:

      • query_sql (Zeichenfolge): Die auszuführende SELECT-SQL-Abfrage

    • Gibt zurück: Abfrageergebnisse als Array von Objekten

Tabellenmodell

Abfragetools
  • read_query

    • Führen Sie SELECT-Abfragen aus, um Daten aus der Datenbank zu lesen

    • Eingang:

      • query (Zeichenfolge): Die auszuführende SELECT-SQL-Abfrage

    • Gibt zurück: Abfrageergebnisse als Array von Objekten

Schema-Tools
  • list_tables

    • Holen Sie sich eine Liste aller Tabellen in der Datenbank

    • Keine Eingabe erforderlich

    • Rückgabe: Array von Tabellennamen

  • describe-table

    • Schemainformationen für eine bestimmte Tabelle anzeigen

    • Eingang:

      • table_name (Zeichenfolge): Name der zu beschreibenden Tabelle

    • Rückgabe: Array von Spaltendefinitionen mit Namen und Typen

Claude Desktop Integration

Voraussetzungen

  • Python mit uv -Paketmanager

  • IoTDB-Installation

  • MCP-Serverabhängigkeiten

Entwicklung

# Clone the repository
git clone https://github.com/apache/iotdb-mcp-server.git
cd iotdb_mcp_server

# Create virtual environment
uv venv
source venv/bin/activate  # or `venv\Scripts\activate` on Windows

# Install development dependencies
uv sync

Konfigurieren Sie den MCP-Server in der Konfigurationsdatei von Claude Desktop:

macOS

Speicherort: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows

Speicherort: %APPDATA%/Claude/claude_desktop_config.json

Möglicherweise müssen Sie den vollständigen Pfad zur UV-Programmdatei in das Befehlsfeld eingeben. Sie erhalten diesen, indem Sie which uv unter MacOS/Linux oder where uv unter Windows ausführen.

{
  "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",
        "IOTDB_SQL_DIALECT": "table"
      }
    }
  }
}

Available Tools

4 tools
describe_tableC

Get the schema information for a specific table Args: table_name: name of the table to describe

Inputs: table_name (required).

export_table_queryA

Execute a query and export the results to a CSV or Excel file.

Args: query_sql: The SQL query to execute (using TABLE dialect, time using ISO 8601 format, e.g. 2017-11-01T00:08:00.000) format: Export format, either "csv" or "excel" (default: "csv") filename: Optional filename for the exported file. If not provided, a unique filename will be generated.

SQL Syntax: SELECT ⟨select_list⟩ FROM ⟨tables⟩ [WHERE ⟨condition⟩] [GROUP BY ⟨groups⟩] [HAVING ⟨group_filter⟩] [FILL ⟨fill_methods⟩] [ORDER BY ⟨order_expression⟩] [OFFSET ⟨n⟩] [LIMIT ⟨n⟩];

Returns: Information about the exported file and a preview of the data (max 10 rows)

Inputs: query_sql (required), format, filename.

list_tablesB

List all tables in the IoTDB database.

Inputs: no named parameters.

read_queryB

Execute a SELECT query on the IoTDB. Please use table sql_dialect when generating SQL queries.

Args: query_sql: The SQL query to execute (using TABLE dialect, time using ISO 8601 format, e.g. 2017-11-01T00:08:00.000)

Inputs: query_sql (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.1/5.0

    Scored across 4 tools

    Disambiguation3/5

    The tools have distinct primary functions (describe, export, list, read), but there's significant overlap between export_table_query and read_query as both execute SQL queries. The descriptions clarify that export_table_query focuses on file export while read_query returns query results directly, but an agent might still confuse when to use each for data retrieval.

    Naming Consistency4/5

    Three tools follow a consistent verb_noun pattern (describe_table, list_tables, export_table_query), while read_query deviates slightly by using 'read' instead of a more specific verb like 'execute' or 'run'. The naming is mostly predictable and readable, with only minor inconsistency in the verb choice for one tool.

    Tool Count4/5

    Four tools is a reasonable count for a database server, allowing core operations without being overwhelming. However, it feels slightly thin for full IoTDB coverage, as it lacks tools for table creation, deletion, or data insertion, which might be expected in a complete database interface.

    Completeness2/5

    The toolset is severely incomplete for a database server. It covers read operations (list, describe, query) and export, but lacks any write capabilities (create, insert, update, delete) or administrative functions. This creates significant gaps that will cause agent failures when trying to perform basic database management tasks.

    Maintenance

    ActivityStale
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      A Model Context Protocol server that enables SQL query execution, database management, and business intelligence capabilities through MySQL connections.
      1,462 npm
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      A Model Context Protocol server that enables natural language queries to MySQL databases, powered by XiYanSQL text-to-SQL technology.
      239
      Apache 2.0
    • A
      license
      B
      quality
      D
      maintenance
      A Model Context Protocol server that enables executing SQL queries and managing connections with Microsoft SQL Server databases.
      1
      6
      MIT
    • F
      license
      B
      quality
      D
      maintenance
      A Model Context Protocol server that allows executing SELECT queries on TiDB databases, with optional support for INSERT, UPDATE, and DELETE operations when explicitly enabled.
      1
      8 npm
      -