what is IoTDB MCP Server?
IoTDB MCP Server is a Model Context Protocol (MCP) server implementation that facilitates database interaction and business intelligence capabilities through IoTDB, allowing users to run SQL queries.
how to use IoTDB MCP Server?
To use the IoTDB MCP Server, clone the repository, set up a virtual environment, install dependencies, and configure the server in the Claude Desktop's configuration file. You can then execute SQL queries using the provided tools.
key features of IoTDB MCP Server?
- Execute SELECT queries to read data from the database.
- List all tables in the database.
- View schema information for specific tables.
use cases of IoTDB MCP Server?
- Running SQL queries to retrieve data from IoTDB.
- Analyzing database schemas for better understanding of data structure.
- Integrating with business intelligence tools for data analysis.
FAQ from IoTDB MCP Server?
- What are the prerequisites for using IoTDB MCP Server?
You need Python with the
uv
package manager, IoTDB installation, and MCP server dependencies.
- How do I configure the server?
You need to edit the Claude Desktop's configuration file to include the MCP server settings.
- Can I run multiple queries at once?
The server is designed to handle one query at a time, but you can execute multiple queries sequentially.
IoTDB MCP Server for Tree Model
Overview
A Model Context Protocol (MCP) server implementation that provides database interaction and business intelligence capabilities through IoTDB. This server enables running SQL queries.
Components
Resources
The server doesn't expose any resources.
Prompts
The server doesn't provide any prompts.
Tools
The server offers three core tools:
Query Tools
metadata_query
- Execute SHOW/COUNT queries to read metadata from the database
- Input:
query_sql
(string): The SHOW/COUNT SQL query to execute- Returns: Query results as array of objects
select_query
- Execute SELECT queries to read data from the database
- Input:
query_sql
(string): The SELECT SQL query to execute
- Returns: Query results as array of objects
Claude Desktop Integration
Prerequisites
- Python with
uv
package manager - IoTDB installation
- MCP server dependencies
Development
# 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
Configure the MCP server in Claude Desktop's configuration file:
MacOS
Location: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows
Location: %APPDATA%/Claude/claude_desktop_config.json
You may need to put the full path to the uv executable in the command field. You can get this by running which uv
on MacOS/Linux or where uv
on 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"
}
}
}
}