https://github.com/apache/iotdb-mcp-server
Apache iotdb
https://github.com/apache/iotdb-mcp-server
Last synced: 3 months ago
JSON representation
Apache iotdb
- Host: GitHub
- URL: https://github.com/apache/iotdb-mcp-server
- Owner: apache
- License: apache-2.0
- Created: 2025-04-02T07:44:29.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-02T08:08:06.000Z (3 months ago)
- Last Synced: 2025-04-02T08:33:39.751Z (3 months ago)
- Language: Python
- Homepage: https://iotdb.apache.org/
- Size: 0 Bytes
- Stars: 1
- Watchers: 19
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- mcp-index - IoTDB MCP Server - Enable secure interaction with IoTDB databases to run SQL queries and explore database schemas through a structured interface. (Databases)
- awesome-mcp-servers - apache/iotdb-mcp-server
README
# 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 three core tools:
#### 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 `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.**
```json
{
"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"
}
}
}
}
```