{"id":47921787,"url":"https://github.com/taosdata/mcp-tdengine-tsdb","last_synced_at":"2026-04-04T06:08:49.006Z","repository":{"id":334144006,"uuid":"1139693223","full_name":"taosdata/mcp-tdengine-tsdb","owner":"taosdata","description":"MCP Server for TDengine TSDB","archived":false,"fork":false,"pushed_at":"2026-01-23T15:16:37.000Z","size":39,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-15T20:25:42.581Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taosdata.png","metadata":{"files":{"readme":"README-CN.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-22T09:42:09.000Z","updated_at":"2026-01-23T15:10:16.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/taosdata/mcp-tdengine-tsdb","commit_stats":null,"previous_names":["taosdata/mcp-tdengine-tsdb"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/taosdata/mcp-tdengine-tsdb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taosdata%2Fmcp-tdengine-tsdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taosdata%2Fmcp-tdengine-tsdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taosdata%2Fmcp-tdengine-tsdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taosdata%2Fmcp-tdengine-tsdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taosdata","download_url":"https://codeload.github.com/taosdata/mcp-tdengine-tsdb/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taosdata%2Fmcp-tdengine-tsdb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31389437,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T04:26:24.776Z","status":"ssl_error","status_checked_at":"2026-04-04T04:23:34.147Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-04T06:08:48.435Z","updated_at":"2026-04-04T06:08:49.001Z","avatar_url":"https://github.com/taosdata.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mcp-tdengine-tsdb\n\n[English](README.md) | 简体中文\n\n## 目录\n\n- [1. 简介](#1-简介)\n- [2. 文档](#2-文档)\n- [3. 前置条件](#3-前置条件)\n- [4. 构建](#4-构建)\n- [5. 测试](#5-测试)\n  - [5.1 运行测试](#51-运行测试)\n  - [5.2 添加用例](#52-添加用例)\n  - [5.3 性能测试](#53-性能测试)\n- [6. CI/CD](#6-cicd)\n- [7. 提交 Issue](#7-提交-issue)\n- [8. 提交 PR](#8-提交-pr)\n- [9. 引用](#9-引用)\n- [10. 许可证](#10-许可证)\n\n## 1. 简介\n\nMCP Server for TDengine TSDB，提供了一套完整的工具集，用于查询、管理和监控 TDengine 时序数据库。\n\n### 核心工具\n\n- **查询工具 (query)** - 执行 TDengine SELECT 查询并返回结果\n- **显示工具 (show)** - 执行各种 SHOW 命令查询元数据，支持多种参数选项\n- **信息工具 (info)** - 提供 TDengine 服务器信息，包括版本、状态等\n- **描述表工具 (describe_table)** - 描述指定表的结构\n- **预定义schema获取工具 (get_schema_overview)** - 获取数据库结构概览信息\n\n### 技术特点\n\n- 基于 Go 语言开发，轻量高效\n- 使用 TDengine WebSocket 驱动连接数据库\n- 支持通过命令行参数和环境变量配置\n- CSV 格式结果输出\n\n## 2. 文档\n\n### 配置选项\n\n| 参数                       | 环境变量                            | 默认值         | 描述                                                                 |\n|:---------------------------|:------------------------------------|:---------------|:---------------------------------------------------------------------|\n| `--host`                   | `TDENGINE_HOST`                     | `localhost`    | TDengine 主机名                                                      |\n| `--port`                   | `TDENGINE_PORT`                     | `6041`         | TDengine 端口（taosAdapter 端口）                                    |\n| `--user`                   | `TDENGINE_USER`                     | `root`         | TDengine 用户名                                                      |\n| `--pass`                   | `TDENGINE_PASS`                     | `taosdata`     | TDengine 密码                                                        |\n| `--db`                     | `TDENGINE_DB`                       |                | TDengine 数据库名                                                    |\n| `--dsn`                    | `TDENGINE_DSN`                      |                | TDengine 数据源名称 (DSN)，优先级高于单独的连接参数                     |\n| `--schema_overview_file`   | `TDENGINE_SCHEMA_OVERVIEW_FILE`     |                | 预定义数据库schema概览文件路径                                         |\n\n### 使用说明\n\n#### 安装\n\n1. 下载最新的 [release](https://github.com/taosdata/mcp-tdengine-tsdb/releases)\n2. 将可执行文件放置在系统的 `$PATH` 中，或放在一个便于访问的位置。\n3. 或者，如果你已经安装了 Go，可以通过以下命令从源代码构建：\n\n```bash\ngo install -v github.com/taosdata/mcp-tdengine-tsdb@latest\n```\n\n#### 配置 MCP\n\n添加到 MCP 配置文件中的示例：\n\n```json\n{\n  \"mcpServers\": {\n    \"tdengine-tsdb\": {\n      \"command\": \"mcp-tdengine-tsdb\",\n      \"args\": [\n        \"--host\", \"localhost\",\n        \"--port\", \"6041\",\n        \"--user\", \"root\",\n        \"--pass\", \"taosdata\",\n        \"--db\", \"test\"\n      ]\n    }\n  }\n}\n```\n\n- `command`：指定可执行文件名称或路径\n- `args`：传递给可执行文件的参数列表\n\n## 3. 前置条件\n\n- Go 1.24.12 环境\n- TDengine 数据库 3.3.6.0 及以上版本\n- Git 版本控制工具\n\n## 4. 构建\n\n### 克隆仓库\n\n```bash\ngit clone https://github.com/taosdata/mcp-tdengine-tsdb.git\ncd mcp-tdengine-tsdb\n```\n\n### 构建项目\n\n```bash\ngo build -o mcp-tdengine-tsdb\n```\n\n## 5. 测试\n\n**测试将使用 `test` 数据库进行操作，测试完成后会删除此数据库，请确保 `test` 数据库不存在重要数据。**\n\n### 5.1 运行测试\n\n1. 执行测试前确保已经安装 TDengine 服务端，并且已经启动 taosd 与 taosAdapter，数据库干净无数据。\n2. 项目目录下执行 `go test ./...` 运行测试，测试会连接到本地的 TDengine 服务器与 taosAdapter 进行测试。\n3. 输出结果 `PASS` 为测试通过，`FAIL` 为测试失败，查看详细信息需要执行 `go test -v ./...`。\n\n### 5.2 添加用例\n\n在 `*_test.go` 文件中添加测试用例，确保测试用例覆盖到新增的代码。\n\n### 5.3 性能测试\n\n性能测试还在开发中。\n\n## 6. CI/CD\n\n项目使用 GitHub Actions 进行持续集成和持续部署 (CI/CD)，配置文件位于 `.github/workflows/build.yml`。\n\n当代码推送到 `main` 分支或创建针对 `main` 分支的拉取请求时，CI 工作流将自动触发，执行自动化构建和测试。\n\n## 7. 提交 Issue\n\n我们欢迎提交 [GitHub Issue](https://github.com/taosdata/mcp-tdengine-tsdb/issues/new?template=Blank+issue)。 提交时请说明下面信息：\n\n- 问题描述\n- 复现步骤\n- 预期行为\n- 实际行为\n- 环境信息\n- 相关截图或日志\n\n## 8. 提交 PR\n\n我们欢迎开发者一起开发本项目，提交 PR 时请参考下面步骤：\n\n1. Fork 本项目，请参考 ([how to fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo))。\n2. 从 main 分支创建一个新分支，请使用有意义的分支名称 (`git checkout -b my_branch`)。\n3. 修改代码，保证所有单元测试通过，并增加新的单元测试验证修改。\n4. 提交修改到远端分支 (`git push origin my_branch`)。\n5. 在 GitHub 上创建一个 Pull\n   Request ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request))。\n6. 提交 PR 后，可以通过 [Pull Request](https://github.com/taosdata/mcp-tdengine-tsdb/pulls) 找到自己的 PR，点击对应链接进去可以看到自己\n   PR CI 是否通过，如果通过会显示 “All checks have passed”。无论 CI 是否通过，都可以点击 “Show all checks” -\u003e “Details”\n   来查看详细用例日志。\n7. 提交 PR 后，如果 CI 通过，可以在 [codecov](https://app.codecov.io/gh/taosdata/mcp-tdengine-tsdb/pulls) 页面找到自己 PR 查看覆盖率。\n\n## 9. 引用\n\n- [TDengine 官网](https://www.taosdata.com/)\n- [TDengine GitHub](https://github.com/taosdata/TDengine)\n\n## 10. 许可证\n\n[MIT License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaosdata%2Fmcp-tdengine-tsdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaosdata%2Fmcp-tdengine-tsdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaosdata%2Fmcp-tdengine-tsdb/lists"}