This is an automated email from the ASF dual-hosted git repository. jackietien pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/iotdb-mcp-server.git
commit f3242c46ebdec06a213f92d846b04f805d0bc18a Author: JackieTien97 <[email protected]> AuthorDate: Wed Apr 2 15:54:50 2025 +0800 Support mcp server for IoTDB Support mcp server for IoTDB --- .asf | 40 ++++++++ .gitignore | 23 +++++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++ README.md | 96 +++++++++++++++++++ asf.header | 16 ++++ pyproject.toml | 34 +++++++ src/iotdb_mcp_server/__init__.py | 34 +++++++ src/iotdb_mcp_server/config.py | 104 ++++++++++++++++++++ src/iotdb_mcp_server/server.py | 131 +++++++++++++++++++++++++ 9 files changed, 679 insertions(+) diff --git a/.asf b/.asf new file mode 100644 index 0000000..ecb37c4 --- /dev/null +++ b/.asf @@ -0,0 +1,40 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +github: + description: "Apache IoTDB MCP Server" + homepage: https://iotdb.apache.org/ + labels: + - timeseries + - database + - iot + - mcp-server + - big-data + - python + - tsdb + features: + wiki: true + issues: true + enabled_merge_buttons: + # enable squash button: + squash: true + # enable merge button: + merge: false + # disable rebase button: + rebase: true \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d53d616 --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ +# Python-generated files +__pycache__/ +*.py[oc] +build/ +dist/ +wheels/ +*.egg-info + +# Virtual environments +.venv +Lib/ +Scripts/ + +# Development environment +.python-version +uv.lock + +# IDE settings (optional) +.vscode/ +.idea/ + +# Distribution directories +*.dist-info/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c0e6155 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# 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" + } + } + } +} +``` \ No newline at end of file diff --git a/asf.header b/asf.header new file mode 100644 index 0000000..c1640de --- /dev/null +++ b/asf.header @@ -0,0 +1,16 @@ +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..2a7f0b3 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,34 @@ +[project] +name = "iotdb-mcp-server" +packages = [{ include = "src/iotdb_mcp_server" }] +version = "0.1.0" +description = "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." +readme = "README.md" +license = "Apache-2.0" +license-file="LICENSE" +requires-python = ">=3.12" +dependencies = [ + "mcp>=1.0.0", + "apache-iotdb>=2.0.1b0" +] + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.hatch.build] +exclude = [ + "venv", + ".git", + ".gitignore" +] + +[tool.uv] +dev-dependencies = [ + "pyright", + "black", + "flake8", +] + +[project.scripts] +iotdb-mcp-server = "iotdb_mcp_server:main" \ No newline at end of file diff --git a/src/iotdb_mcp_server/__init__.py b/src/iotdb_mcp_server/__init__.py new file mode 100644 index 0000000..bd6c83b --- /dev/null +++ b/src/iotdb_mcp_server/__init__.py @@ -0,0 +1,34 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +from iotdb_mcp_server.config import Config +import sys + +if not "-m" in sys.argv: + from . import server +import asyncio + + +def main(): + """Main entry point for the package.""" + _config = Config.from_env_arguments() + asyncio.run(server.main(_config)) + + +# Expose important items at package level +__all__ = ["main", "server"] diff --git a/src/iotdb_mcp_server/config.py b/src/iotdb_mcp_server/config.py new file mode 100644 index 0000000..db6875a --- /dev/null +++ b/src/iotdb_mcp_server/config.py @@ -0,0 +1,104 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +import argparse +from dataclasses import dataclass +import os + + +@dataclass +class Config: + """ + Configuration for the IoTDB mcp server. + """ + + host: str + """ + IoTDB host + """ + + port: int + """ + IoTDB port + """ + + user: str + """ + IoTDB username + """ + + password: str + """ + IoTDB password + """ + + database: str + """ + IoTDB database name + """ + + @staticmethod + def from_env_arguments() -> "Config": + """ + Parse command line arguments. + """ + parser = argparse.ArgumentParser(description="IoTDB MCP Server") + + parser.add_argument( + "--host", + type=str, + help="IoTDB host", + default=os.getenv("IOTDB_HOST", "127.0.0.1"), + ) + + parser.add_argument( + "--port", + type=int, + help="IoTDB MySQL protocol port", + default=os.getenv("IOTDB_PORT", 6667), + ) + + parser.add_argument( + "--database", + type=str, + help="IoTDB connect database name", + default=os.getenv("IOTDB_DATABASE", "test"), + ) + + parser.add_argument( + "--user", + type=str, + help="IoTDB username", + default=os.getenv("IOTDB_USER", "root"), + ) + + parser.add_argument( + "--password", + type=str, + help="IoTDB password", + default=os.getenv("IOTDB_PASSWORD", "root"), + ) + + args = parser.parse_args() + return Config( + host=args.host, + port=args.port, + database=args.database, + user=args.user, + password=args.password, + ) diff --git a/src/iotdb_mcp_server/server.py b/src/iotdb_mcp_server/server.py new file mode 100644 index 0000000..0527bc2 --- /dev/null +++ b/src/iotdb_mcp_server/server.py @@ -0,0 +1,131 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +import logging + +from iotdb.table_session import TableSession +from iotdb.table_session_pool import TableSessionPool, TableSessionPoolConfig +from iotdb.utils.SessionDataSet import SessionDataSet +from mcp.server.fastmcp import FastMCP +from mcp.types import ( + TextContent, +) + +from iotdb_mcp_server.config import Config + +# Initialize FastMCP server +mcp = FastMCP("iotdb_mcp_server") + +# Configure logging +logging.basicConfig( + level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s" +) + +logger = logging.getLogger("iotdb_mcp_server") + +config = Config.from_env_arguments() + +db_config = { + "host": config.host, + "port": config.port, + "user": config.user, + "password": config.password, + "database": config.database, +} + +logger.info(f"IoTDB Config: {db_config}") + +session_pool_config = TableSessionPoolConfig( + node_urls=[str(config.host) + ":" + str(config.port)], + username=config.user, + password=config.password, + database=None if len(config.database) == 0 else config.database, +) + +session_pool = TableSessionPool(session_pool_config) + + [email protected]() +async def read_query(query_sql: str) -> list[TextContent]: + """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) + """ + table_session = session_pool.get_session() + res = table_session.execute_query_statement(query_sql) + + stmt = query_sql.strip().upper() + # Regular SELECT queries + if ( + stmt.startswith("SELECT") + or stmt.startswith("DESCRIBE") + or stmt.startswith("SHOW") + ): + return prepare_res(res, table_session) + # Non-SELECT queries + else: + raise ValueError("Only SELECT queries are allowed for read_query") + + [email protected]() +async def list_tables() -> list[TextContent]: + """List all tables in the IoTDB database.""" + table_session = session_pool.get_session() + res = table_session.execute_query_statement("SHOW TABLES") + + result = ["Tables_in_" + db_config["database"]] # Header + while res.has_next(): + result.append(str(res.next().get_fields()[0])) + table_session.close() + return [TextContent(type="text", text="\n".join(result))] + + [email protected]() +async def describe_table(table_name: str) -> list[TextContent]: + """Get the schema information for a specific table + Args: + table_name: name of the table to describe + """ + table_session = session_pool.get_session() + res = table_session.execute_query_statement("DESC " + table_name) + + return prepare_res(res, table_session) + + +def prepare_res( + _res: SessionDataSet, _table_session: TableSession +) -> list[TextContent]: + columns = _res.get_column_names() + result = [] + while _res.has_next(): + row = _res.next().get_fields() + result.append(",".join(map(str, row))) + _table_session.close() + return [ + TextContent( + type="text", + text="\n".join([",".join(columns)] + result), + ) + ] + + +if __name__ == "__main__": + logger.info("iotdb_mcp_server running with stdio transport") + # Initialize and run the server + mcp.run(transport="stdio")
