A Model Context Protocol (MCP) server that enables secure interaction with IoTDB databases. This server allows AI assistants to list tables, read data, and execute SQL queries through a controlled interface, making database exploration and analysis safer and more structured.
Project description
IoTDB MCP Server
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 different tools for IoTDB Tree Model and Table Model. You can choose between them by setting the "IOTDB_SQL_DIALECT" configuration to either "tree" or "table".
Tree Model
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
Table Model
Query Tools
read_query- Execute SELECT queries to read data from the database
- Input:
query(string): The SELECT SQL query to execute
- Returns: Query results as array of objects
Schema Tools
-
list_tables- Get a list of all tables in the database
- No input required
- Returns: Array of table names
-
describe-table- View schema information for a specific table
- Input:
table_name(string): Name of table to describe
- Returns: Array of column definitions with names and types
Claude Desktop Integration
Prerequisites
- Python with
uvpackage 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",
"IOTDB_SQL_DIALECT": "table"
}
}
}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file iotdb_mcp_server-0.2.0.tar.gz.
File metadata
- Download URL: iotdb_mcp_server-0.2.0.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4105bdba9c22d610e8daf579c3b1dcbfba0549c864b1642e73b6efb042d16af8
|
|
| MD5 |
779e5bf06ff43ed2734c48a511416115
|
|
| BLAKE2b-256 |
68ebc175e795be368ebcdaf59a192911cd358e0994771ee06f7153193b850327
|
File details
Details for the file iotdb_mcp_server-0.2.0-py3-none-any.whl.
File metadata
- Download URL: iotdb_mcp_server-0.2.0-py3-none-any.whl
- Upload date:
- Size: 11.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
146927286da83d4850c47d37b5b905668233a2c2554809500315d2ff732c10b8
|
|
| MD5 |
76f8ceb809631483a37e6880c0330dbc
|
|
| BLAKE2b-256 |
8231818f39ff7aa3f71974eb0eced81a31bc21d5e78ab38f2255f59381adb6a5
|