mcp-dbutils 0.17.0__tar.gz → 0.19.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (164) hide show
  1. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/.gitignore +1 -1
  2. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/CHANGELOG.md +14 -0
  3. mcp_dbutils-0.19.0/PKG-INFO +145 -0
  4. mcp_dbutils-0.19.0/README.md +120 -0
  5. mcp_dbutils-0.19.0/README_AR.md +127 -0
  6. mcp_dbutils-0.19.0/README_EN.md +118 -0
  7. mcp_dbutils-0.19.0/README_ES.md +116 -0
  8. mcp_dbutils-0.19.0/README_FR.md +116 -0
  9. mcp_dbutils-0.19.0/README_RU.md +123 -0
  10. mcp_dbutils-0.19.0/docs/ar/configuration.md +362 -0
  11. mcp_dbutils-0.19.0/docs/ar/examples/README.md +29 -0
  12. mcp_dbutils-0.19.0/docs/ar/examples/advanced-llm-interactions.md +267 -0
  13. mcp_dbutils-0.19.0/docs/ar/examples/mysql-examples.md +252 -0
  14. mcp_dbutils-0.19.0/docs/ar/examples/postgresql-examples.md +331 -0
  15. mcp_dbutils-0.19.0/docs/ar/examples/sqlite-examples.md +154 -0
  16. mcp_dbutils-0.19.0/docs/ar/installation-platform-specific.md +323 -0
  17. mcp_dbutils-0.19.0/docs/ar/installation.md +347 -0
  18. mcp_dbutils-0.19.0/docs/ar/technical/architecture.md +204 -0
  19. mcp_dbutils-0.19.0/docs/ar/technical/development.md +429 -0
  20. mcp_dbutils-0.19.0/docs/ar/technical/security.md +318 -0
  21. mcp_dbutils-0.19.0/docs/ar/technical/sonarcloud-integration.md +440 -0
  22. mcp_dbutils-0.19.0/docs/ar/technical/testing.md +547 -0
  23. mcp_dbutils-0.19.0/docs/ar/usage.md +231 -0
  24. mcp_dbutils-0.19.0/docs/document-consistency-check.md +87 -0
  25. mcp_dbutils-0.19.0/docs/document-version-history.md +69 -0
  26. mcp_dbutils-0.19.0/docs/en/configuration.md +361 -0
  27. mcp_dbutils-0.19.0/docs/en/examples/advanced-llm-interactions.md +464 -0
  28. mcp_dbutils-0.19.0/docs/en/examples/mysql-examples.md +497 -0
  29. mcp_dbutils-0.19.0/docs/en/examples/postgresql-examples.md +355 -0
  30. mcp_dbutils-0.19.0/docs/en/examples/sqlite-examples.md +150 -0
  31. mcp_dbutils-0.19.0/docs/en/installation-platform-specific.md +286 -0
  32. mcp_dbutils-0.19.0/docs/en/installation.md +346 -0
  33. mcp_dbutils-0.19.0/docs/en/technical/architecture.md +171 -0
  34. mcp_dbutils-0.19.0/docs/en/technical/development.md +194 -0
  35. mcp_dbutils-0.19.0/docs/en/technical/security.md +171 -0
  36. mcp_dbutils-0.19.0/docs/en/technical/sonarcloud-integration.md +123 -0
  37. mcp_dbutils-0.19.0/docs/en/technical/testing.md +131 -0
  38. mcp_dbutils-0.19.0/docs/en/usage.md +230 -0
  39. mcp_dbutils-0.19.0/docs/es/configuration.md +358 -0
  40. mcp_dbutils-0.19.0/docs/es/examples/README.md +25 -0
  41. mcp_dbutils-0.19.0/docs/es/examples/advanced-llm-interactions.md +267 -0
  42. mcp_dbutils-0.19.0/docs/es/examples/mysql-examples.md +252 -0
  43. mcp_dbutils-0.19.0/docs/es/examples/postgresql-examples.md +331 -0
  44. mcp_dbutils-0.19.0/docs/es/examples/sqlite-examples.md +150 -0
  45. mcp_dbutils-0.19.0/docs/es/installation-platform-specific.md +323 -0
  46. mcp_dbutils-0.19.0/docs/es/installation.md +343 -0
  47. mcp_dbutils-0.19.0/docs/es/technical/architecture.md +204 -0
  48. mcp_dbutils-0.19.0/docs/es/technical/development.md +429 -0
  49. mcp_dbutils-0.19.0/docs/es/technical/security.md +318 -0
  50. mcp_dbutils-0.19.0/docs/es/technical/sonarcloud-integration.md +440 -0
  51. mcp_dbutils-0.19.0/docs/es/technical/testing.md +547 -0
  52. mcp_dbutils-0.19.0/docs/es/usage.md +227 -0
  53. mcp_dbutils-0.19.0/docs/fr/configuration.md +358 -0
  54. mcp_dbutils-0.19.0/docs/fr/examples/README.md +25 -0
  55. mcp_dbutils-0.19.0/docs/fr/examples/advanced-llm-interactions.md +267 -0
  56. mcp_dbutils-0.19.0/docs/fr/examples/mysql-examples.md +252 -0
  57. mcp_dbutils-0.19.0/docs/fr/examples/postgresql-examples.md +331 -0
  58. mcp_dbutils-0.19.0/docs/fr/examples/sqlite-examples.md +150 -0
  59. mcp_dbutils-0.19.0/docs/fr/installation-platform-specific.md +323 -0
  60. mcp_dbutils-0.19.0/docs/fr/installation.md +343 -0
  61. mcp_dbutils-0.19.0/docs/fr/technical/architecture.md +204 -0
  62. mcp_dbutils-0.19.0/docs/fr/technical/development.md +429 -0
  63. mcp_dbutils-0.19.0/docs/fr/technical/security.md +318 -0
  64. mcp_dbutils-0.19.0/docs/fr/technical/sonarcloud-integration.md +440 -0
  65. mcp_dbutils-0.19.0/docs/fr/technical/testing.md +547 -0
  66. mcp_dbutils-0.19.0/docs/fr/usage.md +227 -0
  67. mcp_dbutils-0.19.0/docs/index.md +28 -0
  68. mcp_dbutils-0.19.0/docs/ru/configuration.md +358 -0
  69. mcp_dbutils-0.19.0/docs/ru/examples/README.md +25 -0
  70. mcp_dbutils-0.19.0/docs/ru/examples/advanced-llm-interactions.md +267 -0
  71. mcp_dbutils-0.19.0/docs/ru/examples/mysql-examples.md +331 -0
  72. mcp_dbutils-0.19.0/docs/ru/examples/postgresql-examples.md +495 -0
  73. mcp_dbutils-0.19.0/docs/ru/examples/sqlite-examples.md +150 -0
  74. mcp_dbutils-0.19.0/docs/ru/installation-platform-specific.md +323 -0
  75. mcp_dbutils-0.19.0/docs/ru/installation.md +343 -0
  76. mcp_dbutils-0.19.0/docs/ru/technical/architecture.md +204 -0
  77. mcp_dbutils-0.19.0/docs/ru/technical/development.md +429 -0
  78. mcp_dbutils-0.19.0/docs/ru/technical/security.md +318 -0
  79. mcp_dbutils-0.19.0/docs/ru/technical/sonarcloud-integration.md +440 -0
  80. mcp_dbutils-0.19.0/docs/ru/technical/testing.md +547 -0
  81. mcp_dbutils-0.19.0/docs/ru/usage.md +227 -0
  82. mcp_dbutils-0.19.0/docs/zh/configuration.md +358 -0
  83. mcp_dbutils-0.19.0/docs/zh/examples/advanced-llm-interactions.md +464 -0
  84. mcp_dbutils-0.19.0/docs/zh/examples/mysql-examples.md +497 -0
  85. mcp_dbutils-0.19.0/docs/zh/examples/postgresql-examples.md +355 -0
  86. mcp_dbutils-0.19.0/docs/zh/examples/sqlite-examples.md +150 -0
  87. mcp_dbutils-0.19.0/docs/zh/installation-platform-specific.md +283 -0
  88. mcp_dbutils-0.19.0/docs/zh/installation.md +343 -0
  89. mcp_dbutils-0.19.0/docs/zh/technical/architecture.md +171 -0
  90. mcp_dbutils-0.19.0/docs/zh/technical/development.md +194 -0
  91. mcp_dbutils-0.19.0/docs/zh/technical/security.md +171 -0
  92. mcp_dbutils-0.19.0/docs/zh/technical/sonarcloud-integration.md +123 -0
  93. mcp_dbutils-0.19.0/docs/zh/technical/testing.md +131 -0
  94. mcp_dbutils-0.19.0/docs/zh/usage.md +227 -0
  95. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/pyproject.toml +1 -1
  96. mcp_dbutils-0.19.0/scripts/check_docs_consistency.py +277 -0
  97. mcp_dbutils-0.19.0/scripts/check_zh_docs.py +100 -0
  98. mcp_dbutils-0.19.0/scripts/fix_en_nav_links.py +104 -0
  99. mcp_dbutils-0.19.0/scripts/fix_zh_nav_links.py +61 -0
  100. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/base.py +364 -178
  101. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/mysql/handler.py +52 -32
  102. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/postgres/handler.py +50 -30
  103. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/sqlite/handler.py +68 -53
  104. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/fixtures.py +21 -18
  105. mcp_dbutils-0.19.0/tests/integration/test_list_connections.py +149 -0
  106. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_base.py +109 -101
  107. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_base_server.py +185 -180
  108. mcp_dbutils-0.17.0/PKG-INFO +0 -308
  109. mcp_dbutils-0.17.0/README.md +0 -283
  110. mcp_dbutils-0.17.0/README_CN.md +0 -294
  111. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/.coveragerc +0 -0
  112. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/.github/workflows/code-style.yml +0 -0
  113. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/.github/workflows/quality-assurance.yml +0 -0
  114. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/.github/workflows/release.yml +0 -0
  115. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/.pre-commit-config.yaml +0 -0
  116. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/.releaserc.json +0 -0
  117. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/Dockerfile +0 -0
  118. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/LICENSE +0 -0
  119. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/config.yaml.example +0 -0
  120. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/scripts/fix_imports.sh +0 -0
  121. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/scripts/fix_remaining_issues.sh +0 -0
  122. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/scripts/run_sonar_analysis.sh +0 -0
  123. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/scripts/sonar-ai-fix.fish +0 -0
  124. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/smithery.yaml +0 -0
  125. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/sonar-project.properties +0 -0
  126. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/__init__.py +0 -0
  127. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/config.py +0 -0
  128. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/log.py +0 -0
  129. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/mysql/__init__.py +0 -0
  130. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/mysql/config.py +0 -0
  131. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/mysql/server.py +0 -0
  132. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/postgres/__init__.py +0 -0
  133. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/postgres/config.py +0 -0
  134. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/postgres/server.py +0 -0
  135. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/sqlite/__init__.py +0 -0
  136. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/sqlite/config.py +0 -0
  137. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/sqlite/server.py +0 -0
  138. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/src/mcp_dbutils/stats.py +0 -0
  139. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/conftest.py +0 -0
  140. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/__init__.py +0 -0
  141. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/conftest.py +0 -0
  142. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_logging.py +0 -0
  143. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_monitoring.py +0 -0
  144. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_monitoring_enhanced.py +0 -0
  145. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_mysql.py +0 -0
  146. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_mysql_config.py +0 -0
  147. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_mysql_config_helpers.py +0 -0
  148. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_mysql_handler_extended.py +0 -0
  149. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_postgres.py +0 -0
  150. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_postgres_config.py +0 -0
  151. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_prompts.py +0 -0
  152. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_sqlite.py +0 -0
  153. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_sqlite_config.py +0 -0
  154. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_sqlite_handler_extended.py +0 -0
  155. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_tools.py +0 -0
  156. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/integration/test_tools_advanced.py +0 -0
  157. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_base_handlers.py +0 -0
  158. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_base_helpers.py +0 -0
  159. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_log.py +0 -0
  160. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_mysql_handler.py +0 -0
  161. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_mysql_server.py +0 -0
  162. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_postgres_server.py +0 -0
  163. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_sqlite_server.py +0 -0
  164. {mcp_dbutils-0.17.0 → mcp_dbutils-0.19.0}/tests/unit/test_stats.py +0 -0
@@ -1,5 +1,5 @@
1
1
  # Python
2
- docs/
2
+ docs/local/
3
3
  __pycache__/
4
4
  *.py[cod]
5
5
  *$py.class
@@ -1,3 +1,17 @@
1
+ # [0.19.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.18.0...v0.19.0) (2025-04-25)
2
+
3
+
4
+ ### Features
5
+
6
+ * 完成多语言文档 ([#74](https://github.com/donghao1393/mcp-dbutils/issues/74)) ([aa5d7a6](https://github.com/donghao1393/mcp-dbutils/commit/aa5d7a6c4648bd575d538906d1dcd65ba5ba8c56))
7
+
8
+ # [0.18.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.17.0...v0.18.0) (2025-04-25)
9
+
10
+
11
+ ### Features
12
+
13
+ * add dbutils-list-connections tool ([#68](https://github.com/donghao1393/mcp-dbutils/issues/68)) ([44ce9ac](https://github.com/donghao1393/mcp-dbutils/commit/44ce9ac9a63fcd43a0c817ee72b508380f36ba8d))
14
+
1
15
  # [0.17.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.16.1...v0.17.0) (2025-03-16)
2
16
 
3
17
 
@@ -0,0 +1,145 @@
1
+ Metadata-Version: 2.4
2
+ Name: mcp-dbutils
3
+ Version: 0.19.0
4
+ Summary: MCP Database Utilities Service
5
+ Author: Dong Hao
6
+ License-Expression: MIT
7
+ License-File: LICENSE
8
+ Requires-Python: >=3.10
9
+ Requires-Dist: mcp>=1.2.1
10
+ Requires-Dist: mysql-connector-python>=8.2.0
11
+ Requires-Dist: psycopg2-binary>=2.9.10
12
+ Requires-Dist: python-dotenv>=1.0.1
13
+ Requires-Dist: pyyaml>=6.0.2
14
+ Provides-Extra: test
15
+ Requires-Dist: aiosqlite>=0.19.0; extra == 'test'
16
+ Requires-Dist: docker>=7.0.0; extra == 'test'
17
+ Requires-Dist: pre-commit>=3.6.0; extra == 'test'
18
+ Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test'
19
+ Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
20
+ Requires-Dist: pytest-docker>=2.0.0; extra == 'test'
21
+ Requires-Dist: pytest>=7.0.0; extra == 'test'
22
+ Requires-Dist: ruff>=0.3.0; extra == 'test'
23
+ Requires-Dist: testcontainers>=3.7.0; extra == 'test'
24
+ Description-Content-Type: text/markdown
25
+
26
+ # MCP 数据库工具
27
+
28
+ <!-- 项目状态徽章 -->
29
+ [![构建状态](https://img.shields.io/github/workflow/status/donghao1393/mcp-dbutils/Quality%20Assurance?label=tests)](https://github.com/donghao1393/mcp-dbutils/actions)
30
+ [![覆盖率](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/donghao1393/bdd0a63ec2a816539ff8c136ceb41e48/raw/coverage.json)](https://github.com/donghao1393/mcp-dbutils/actions)
31
+ [![质量门禁状态](https://sonarcloud.io/api/project_badges/measure?project=donghao1393_mcp-dbutils&metric=alert_status)](https://sonarcloud.io/dashboard?id=donghao1393_mcp-dbutils)
32
+
33
+ <!-- 版本和安装徽章 -->
34
+ [![PyPI 版本](https://img.shields.io/pypi/v/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
35
+ [![PyPI 下载量](https://img.shields.io/pypi/dm/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
36
+ [![Smithery](https://smithery.ai/badge/@donghao1393/mcp-dbutils)](https://smithery.ai/server/@donghao1393/mcp-dbutils)
37
+
38
+ <!-- 技术规格徽章 -->
39
+ [![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
40
+ [![许可证](https://img.shields.io/github/license/donghao1393/mcp-dbutils)](LICENSE)
41
+ [![GitHub 星标](https://img.shields.io/github/stars/donghao1393/mcp-dbutils?style=social)](https://github.com/donghao1393/mcp-dbutils/stargazers)
42
+
43
+ [English](README_EN.md) | [Français](README_FR.md) | [Español](README_ES.md) | [العربية](README_AR.md) | [Русский](README_RU.md) | [文档导航](#文档导航)
44
+
45
+ ![Image](https://github.com/user-attachments/assets/26c4f1a1-7b19-4bdd-b9fd-34ad198b0ce3)
46
+
47
+ ## 简介
48
+
49
+ MCP Database Utilities 是一个多功能的 MCP 服务,它使您的 AI 能够通过统一的连接配置安全地访问各种类型的数据库(SQLite、MySQL、PostgreSQL 等)进行数据分析。
50
+
51
+ 您可以将其视为 AI 系统和数据库之间的安全桥梁,允许 AI 在不直接访问数据库或冒数据修改风险的情况下读取和分析您的数据。
52
+
53
+ ### 核心特性
54
+
55
+ - **安全优先**:严格只读操作,无直接数据库访问,隔离连接,按需连接,自动超时
56
+ - **隐私保障**:本地处理,最小数据暴露,凭证保护,敏感数据屏蔽
57
+ - **多数据库支持**:使用相同的接口连接 SQLite、MySQL、PostgreSQL
58
+ - **简单配置**:所有数据库连接使用单个 YAML 文件
59
+ - **高级功能**:表格浏览、架构分析和查询执行
60
+
61
+ > 🔒 **安全说明**:MCP 数据库工具采用安全优先的架构设计,非常适合注重数据保护的企业、初创公司和个人用户。详细了解我们的[安全架构](docs/zh/technical/security.md)。
62
+
63
+ ## 快速入门
64
+
65
+ 我们提供了多种安装方式,包括 uvx、Docker 和 Smithery。详细的安装和配置步骤请参阅[安装指南](docs/zh/installation.md)。
66
+
67
+ ### 基本步骤
68
+
69
+ 1. **安装**:选择适合您的安装方式([详细说明](docs/zh/installation.md))
70
+ 2. **配置**:创建包含数据库连接信息的 YAML 文件([配置指南](docs/zh/configuration.md))
71
+ 3. **连接**:将配置添加到您的 AI 客户端
72
+ 4. **使用**:开始与您的数据库交互([使用指南](docs/zh/usage.md))
73
+
74
+ ### 示例交互
75
+
76
+ **您**:"能否列出我的数据库中的所有表?"
77
+
78
+ **AI**:"以下是您的数据库中的表:
79
+ - customers(客户)
80
+ - products(产品)
81
+ - orders(订单)
82
+ - inventory(库存)"
83
+
84
+ **您**:"customers 表的结构是什么样的?"
85
+
86
+ **AI**:"customers 表有以下结构:
87
+ - id(整数,主键)
88
+ - name(文本)
89
+ - email(文本)
90
+ - registration_date(日期)"
91
+
92
+ ## 文档导航
93
+
94
+ ### 入门指南
95
+ - [安装指南](docs/zh/installation.md) - 详细的安装步骤和配置说明
96
+ - [平台特定安装指南](docs/zh/installation-platform-specific.md) - 针对不同操作系统的安装说明
97
+ - [配置指南](docs/zh/configuration.md) - 数据库连接配置示例和最佳实践
98
+ - [使用指南](docs/zh/usage.md) - 基本操作流程和常见使用场景
99
+
100
+ ### 技术文档
101
+ - [架构设计](docs/zh/technical/architecture.md) - 系统架构和组件说明
102
+ - [安全架构](docs/zh/technical/security.md) - 安全特性和保护机制
103
+ - [开发指南](docs/zh/technical/development.md) - 代码质量和开发流程
104
+ - [测试指南](docs/zh/technical/testing.md) - 测试框架和最佳实践
105
+ - [SonarCloud 集成](docs/zh/technical/sonarcloud-integration.md) - SonarCloud 与 AI 集成指南
106
+
107
+ ### 示例文档
108
+ - [SQLite 示例](docs/zh/examples/sqlite-examples.md) - SQLite 数据库操作示例
109
+ - [PostgreSQL 示例](docs/zh/examples/postgresql-examples.md) - PostgreSQL 数据库操作示例
110
+ - [MySQL 示例](docs/zh/examples/mysql-examples.md) - MySQL 数据库操作示例
111
+ - [高级 LLM 交互示例](docs/zh/examples/advanced-llm-interactions.md) - 与各类 LLM 的高级交互示例
112
+
113
+ ### 多语言文档
114
+ - **英语** - [English Documentation](docs/en/)
115
+ - **法语** - [Documentation Française](docs/fr/)
116
+ - **西班牙语** - [Documentación en Español](docs/es/)
117
+ - **阿拉伯语** - [التوثيق باللغة العربية](docs/ar/)
118
+ - **俄语** - [Документация на русском](docs/ru/)
119
+
120
+ ### 支持与反馈
121
+ - [GitHub Issues](https://github.com/donghao1393/mcp-dbutils/issues) - 报告问题或请求功能
122
+ - [Smithery](https://smithery.ai/server/@donghao1393/mcp-dbutils) - 简化安装和更新
123
+
124
+ ## 可用工具
125
+
126
+ MCP 数据库工具提供了多种工具,使 AI 能够与您的数据库交互:
127
+
128
+ - **dbutils-list-connections**:列出配置中的所有可用数据库连接
129
+ - **dbutils-list-tables**:列出数据库中的所有表
130
+ - **dbutils-run-query**:执行 SQL 查询(仅 SELECT)
131
+ - **dbutils-get-stats**:获取表统计信息
132
+ - **dbutils-list-constraints**:列出表约束
133
+ - **dbutils-explain-query**:获取查询执行计划
134
+ - **dbutils-get-performance**:获取数据库性能指标
135
+ - **dbutils-analyze-query**:分析查询以进行优化
136
+
137
+ 有关这些工具的详细说明和使用示例,请参阅[使用指南](docs/zh/usage.md)。
138
+
139
+ ## 星标历史
140
+
141
+ [![星标历史图表](https://starchart.cc/donghao1393/mcp-dbutils.svg?variant=adaptive)](https://starchart.cc/donghao1393/mcp-dbutils)
142
+
143
+ ## 许可证
144
+
145
+ 本项目采用 MIT 许可证 - 有关详细信息,请参阅 [LICENSE](LICENSE) 文件。
@@ -0,0 +1,120 @@
1
+ # MCP 数据库工具
2
+
3
+ <!-- 项目状态徽章 -->
4
+ [![构建状态](https://img.shields.io/github/workflow/status/donghao1393/mcp-dbutils/Quality%20Assurance?label=tests)](https://github.com/donghao1393/mcp-dbutils/actions)
5
+ [![覆盖率](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/donghao1393/bdd0a63ec2a816539ff8c136ceb41e48/raw/coverage.json)](https://github.com/donghao1393/mcp-dbutils/actions)
6
+ [![质量门禁状态](https://sonarcloud.io/api/project_badges/measure?project=donghao1393_mcp-dbutils&metric=alert_status)](https://sonarcloud.io/dashboard?id=donghao1393_mcp-dbutils)
7
+
8
+ <!-- 版本和安装徽章 -->
9
+ [![PyPI 版本](https://img.shields.io/pypi/v/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
10
+ [![PyPI 下载量](https://img.shields.io/pypi/dm/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
11
+ [![Smithery](https://smithery.ai/badge/@donghao1393/mcp-dbutils)](https://smithery.ai/server/@donghao1393/mcp-dbutils)
12
+
13
+ <!-- 技术规格徽章 -->
14
+ [![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
15
+ [![许可证](https://img.shields.io/github/license/donghao1393/mcp-dbutils)](LICENSE)
16
+ [![GitHub 星标](https://img.shields.io/github/stars/donghao1393/mcp-dbutils?style=social)](https://github.com/donghao1393/mcp-dbutils/stargazers)
17
+
18
+ [English](README_EN.md) | [Français](README_FR.md) | [Español](README_ES.md) | [العربية](README_AR.md) | [Русский](README_RU.md) | [文档导航](#文档导航)
19
+
20
+ ![Image](https://github.com/user-attachments/assets/26c4f1a1-7b19-4bdd-b9fd-34ad198b0ce3)
21
+
22
+ ## 简介
23
+
24
+ MCP Database Utilities 是一个多功能的 MCP 服务,它使您的 AI 能够通过统一的连接配置安全地访问各种类型的数据库(SQLite、MySQL、PostgreSQL 等)进行数据分析。
25
+
26
+ 您可以将其视为 AI 系统和数据库之间的安全桥梁,允许 AI 在不直接访问数据库或冒数据修改风险的情况下读取和分析您的数据。
27
+
28
+ ### 核心特性
29
+
30
+ - **安全优先**:严格只读操作,无直接数据库访问,隔离连接,按需连接,自动超时
31
+ - **隐私保障**:本地处理,最小数据暴露,凭证保护,敏感数据屏蔽
32
+ - **多数据库支持**:使用相同的接口连接 SQLite、MySQL、PostgreSQL
33
+ - **简单配置**:所有数据库连接使用单个 YAML 文件
34
+ - **高级功能**:表格浏览、架构分析和查询执行
35
+
36
+ > 🔒 **安全说明**:MCP 数据库工具采用安全优先的架构设计,非常适合注重数据保护的企业、初创公司和个人用户。详细了解我们的[安全架构](docs/zh/technical/security.md)。
37
+
38
+ ## 快速入门
39
+
40
+ 我们提供了多种安装方式,包括 uvx、Docker 和 Smithery。详细的安装和配置步骤请参阅[安装指南](docs/zh/installation.md)。
41
+
42
+ ### 基本步骤
43
+
44
+ 1. **安装**:选择适合您的安装方式([详细说明](docs/zh/installation.md))
45
+ 2. **配置**:创建包含数据库连接信息的 YAML 文件([配置指南](docs/zh/configuration.md))
46
+ 3. **连接**:将配置添加到您的 AI 客户端
47
+ 4. **使用**:开始与您的数据库交互([使用指南](docs/zh/usage.md))
48
+
49
+ ### 示例交互
50
+
51
+ **您**:"能否列出我的数据库中的所有表?"
52
+
53
+ **AI**:"以下是您的数据库中的表:
54
+ - customers(客户)
55
+ - products(产品)
56
+ - orders(订单)
57
+ - inventory(库存)"
58
+
59
+ **您**:"customers 表的结构是什么样的?"
60
+
61
+ **AI**:"customers 表有以下结构:
62
+ - id(整数,主键)
63
+ - name(文本)
64
+ - email(文本)
65
+ - registration_date(日期)"
66
+
67
+ ## 文档导航
68
+
69
+ ### 入门指南
70
+ - [安装指南](docs/zh/installation.md) - 详细的安装步骤和配置说明
71
+ - [平台特定安装指南](docs/zh/installation-platform-specific.md) - 针对不同操作系统的安装说明
72
+ - [配置指南](docs/zh/configuration.md) - 数据库连接配置示例和最佳实践
73
+ - [使用指南](docs/zh/usage.md) - 基本操作流程和常见使用场景
74
+
75
+ ### 技术文档
76
+ - [架构设计](docs/zh/technical/architecture.md) - 系统架构和组件说明
77
+ - [安全架构](docs/zh/technical/security.md) - 安全特性和保护机制
78
+ - [开发指南](docs/zh/technical/development.md) - 代码质量和开发流程
79
+ - [测试指南](docs/zh/technical/testing.md) - 测试框架和最佳实践
80
+ - [SonarCloud 集成](docs/zh/technical/sonarcloud-integration.md) - SonarCloud 与 AI 集成指南
81
+
82
+ ### 示例文档
83
+ - [SQLite 示例](docs/zh/examples/sqlite-examples.md) - SQLite 数据库操作示例
84
+ - [PostgreSQL 示例](docs/zh/examples/postgresql-examples.md) - PostgreSQL 数据库操作示例
85
+ - [MySQL 示例](docs/zh/examples/mysql-examples.md) - MySQL 数据库操作示例
86
+ - [高级 LLM 交互示例](docs/zh/examples/advanced-llm-interactions.md) - 与各类 LLM 的高级交互示例
87
+
88
+ ### 多语言文档
89
+ - **英语** - [English Documentation](docs/en/)
90
+ - **法语** - [Documentation Française](docs/fr/)
91
+ - **西班牙语** - [Documentación en Español](docs/es/)
92
+ - **阿拉伯语** - [التوثيق باللغة العربية](docs/ar/)
93
+ - **俄语** - [Документация на русском](docs/ru/)
94
+
95
+ ### 支持与反馈
96
+ - [GitHub Issues](https://github.com/donghao1393/mcp-dbutils/issues) - 报告问题或请求功能
97
+ - [Smithery](https://smithery.ai/server/@donghao1393/mcp-dbutils) - 简化安装和更新
98
+
99
+ ## 可用工具
100
+
101
+ MCP 数据库工具提供了多种工具,使 AI 能够与您的数据库交互:
102
+
103
+ - **dbutils-list-connections**:列出配置中的所有可用数据库连接
104
+ - **dbutils-list-tables**:列出数据库中的所有表
105
+ - **dbutils-run-query**:执行 SQL 查询(仅 SELECT)
106
+ - **dbutils-get-stats**:获取表统计信息
107
+ - **dbutils-list-constraints**:列出表约束
108
+ - **dbutils-explain-query**:获取查询执行计划
109
+ - **dbutils-get-performance**:获取数据库性能指标
110
+ - **dbutils-analyze-query**:分析查询以进行优化
111
+
112
+ 有关这些工具的详细说明和使用示例,请参阅[使用指南](docs/zh/usage.md)。
113
+
114
+ ## 星标历史
115
+
116
+ [![星标历史图表](https://starchart.cc/donghao1393/mcp-dbutils.svg?variant=adaptive)](https://starchart.cc/donghao1393/mcp-dbutils)
117
+
118
+ ## 许可证
119
+
120
+ 本项目采用 MIT 许可证 - 有关详细信息,请参阅 [LICENSE](LICENSE) 文件。
@@ -0,0 +1,127 @@
1
+ <div dir="rtl">
2
+
3
+ # أدوات قواعد بيانات MCP
4
+
5
+ <!-- شارات حالة المشروع -->
6
+ [![حالة البناء](https://img.shields.io/github/workflow/status/donghao1393/mcp-dbutils/Quality%20Assurance?label=tests)](https://github.com/donghao1393/mcp-dbutils/actions)
7
+ [![التغطية](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/donghao1393/bdd0a63ec2a816539ff8c136ceb41e48/raw/coverage.json)](https://github.com/donghao1393/mcp-dbutils/actions)
8
+ [![حالة بوابة الجودة](https://sonarcloud.io/api/project_badges/measure?project=donghao1393_mcp-dbutils&metric=alert_status)](https://sonarcloud.io/dashboard?id=donghao1393_mcp-dbutils)
9
+
10
+ <!-- شارات الإصدار والتثبيت -->
11
+ [![إصدار PyPI](https://img.shields.io/pypi/v/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
12
+ [![تنزيلات PyPI](https://img.shields.io/pypi/dm/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
13
+ [![Smithery](https://smithery.ai/badge/@donghao1393/mcp-dbutils)](https://smithery.ai/server/@donghao1393/mcp-dbutils)
14
+
15
+ <!-- شارات المواصفات التقنية -->
16
+ [![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
17
+ [![الترخيص](https://img.shields.io/github/license/donghao1393/mcp-dbutils)](LICENSE)
18
+ [![نجوم GitHub](https://img.shields.io/github/stars/donghao1393/mcp-dbutils?style=social)](https://github.com/donghao1393/mcp-dbutils/stargazers)
19
+
20
+ [English](README_EN.md) | [中文](README.md) | [Français](README_FR.md) | [Español](README_ES.md) | العربية | [Русский](README_RU.md) | [التوثيق](#التوثيق)
21
+
22
+ ## مقدمة
23
+
24
+ أدوات قواعد بيانات MCP هي خدمة MCP شاملة تمكّن الذكاء الاصطناعي الخاص بك من إجراء تحليل البيانات من خلال الوصول إلى أنواع متنوعة من قواعد البيانات (SQLite وMySQL وPostgreSQL والمزيد) ضمن تكوين اتصال موحد بطريقة آمنة.
25
+
26
+ فكر فيها كجسر آمن بين أنظمة الذكاء الاصطناعي وقواعد البيانات الخاصة بك، مما يسمح للذكاء الاصطناعي بقراءة وتحليل بياناتك دون الوصول المباشر إلى قاعدة البيانات أو المخاطرة بتعديلات البيانات.
27
+
28
+ ### الميزات الرئيسية
29
+
30
+ - **الأمان أولاً**: عمليات للقراءة فقط بشكل صارم، لا وصول مباشر لقاعدة البيانات، اتصالات معزولة، اتصال عند الطلب، مهلات تلقائية
31
+ - **ضمانات الخصوصية**: معالجة محلية، الحد الأدنى من كشف البيانات، حماية بيانات الاعتماد، إخفاء البيانات الحساسة
32
+ - **دعم قواعد بيانات متعددة**: اتصل بـ SQLite وMySQL وPostgreSQL بنفس الواجهة
33
+ - **تكوين بسيط**: ملف YAML واحد لجميع اتصالات قاعدة البيانات الخاصة بك
34
+ - **قدرات متقدمة**: استكشاف الجداول، تحليل المخطط، وتنفيذ الاستعلامات
35
+
36
+ > 🔒 **ملاحظة أمان**: تم بناء أدوات قواعد بيانات MCP بهندسة تضع الأمان في المقام الأول، مما يجعلها مثالية للشركات والشركات الناشئة والأفراد الذين يقدرون حماية البيانات. تعرف على المزيد حول [هندسة الأمان](docs/ar/technical/security.md) لدينا.
37
+
38
+ ## البدء السريع
39
+
40
+ نقدم طرق تثبيت متعددة، بما في ذلك uvx وDocker وSmithery. للحصول على خطوات تثبيت وتكوين مفصلة، راجع [دليل التثبيت](docs/ar/installation.md).
41
+
42
+ ### الخطوات الأساسية
43
+
44
+ 1. **التثبيت**: اختر طريقة التثبيت المفضلة لديك ([تعليمات مفصلة](docs/ar/installation.md))
45
+ 2. **التكوين**: قم بإنشاء ملف YAML يحتوي على معلومات اتصال قاعدة البيانات الخاصة بك ([دليل التكوين](docs/ar/configuration.md))
46
+ 3. **الاتصال**: أضف التكوين إلى عميل الذكاء الاصطناعي الخاص بك
47
+ 4. **الاستخدام**: ابدأ التفاعل مع قواعد البيانات الخاصة بك ([دليل الاستخدام](docs/ar/usage.md))
48
+
49
+ ## أمثلة على التفاعلات
50
+
51
+ **أنت**: "هل يمكنك سرد جميع الجداول في قاعدة بيانات my-postgres الخاصة بي؟"
52
+
53
+ **الذكاء الاصطناعي**: "سأتحقق من ذلك لك. إليك الجداول في قاعدة بيانات my-postgres الخاصة بك:
54
+ - العملاء
55
+ - المنتجات
56
+ - الطلبات
57
+ - المخزون
58
+ - الموظفون"
59
+
60
+ **أنت**: "كيف يبدو جدول العملاء؟"
61
+
62
+ **الذكاء الاصطناعي**: "جدول العملاء له البنية التالية:
63
+ - id (عدد صحيح، مفتاح أساسي)
64
+ - الاسم (نص)
65
+ - البريد الإلكتروني (نص)
66
+ - تاريخ_التسجيل (تاريخ)
67
+ - آخر_شراء (تاريخ)
68
+ - إجمالي_الإنفاق (رقمي)"
69
+
70
+ **أنت**: "كم عدد العملاء الذين قاموا بعمليات شراء في الشهر الماضي؟"
71
+
72
+ **الذكاء الاصطناعي**: "دعني أقوم بتشغيل استعلام لمعرفة ذلك... وفقًا للبيانات، قام 128 عميلاً بعمليات شراء في الشهر الماضي. بلغت القيمة الإجمالية لهذه المشتريات 25,437.82 دولارًا."
73
+
74
+ ## الأدوات المتاحة
75
+
76
+ توفر أدوات قواعد بيانات MCP عدة أدوات يمكن للذكاء الاصطناعي الخاص بك استخدامها:
77
+
78
+ - **dbutils-list-connections**: يسرد جميع اتصالات قاعدة البيانات المتاحة في التكوين الخاص بك
79
+ - **dbutils-list-tables**: يسرد جميع الجداول في قاعدة البيانات
80
+ - **dbutils-run-query**: ينفذ استعلام SQL (SELECT فقط)
81
+ - **dbutils-get-stats**: يحصل على إحصائيات حول جدول
82
+ - **dbutils-list-constraints**: يسرد قيود الجدول
83
+ - **dbutils-explain-query**: يحصل على خطة تنفيذ الاستعلام
84
+ - **dbutils-get-performance**: يحصل على مقاييس أداء قاعدة البيانات
85
+ - **dbutils-analyze-query**: يحلل الاستعلامات للتحسين
86
+
87
+ ## التوثيق
88
+
89
+ ### البدء
90
+ - [دليل التثبيت](docs/ar/installation.md) - خطوات تثبيت مفصلة وتعليمات التكوين
91
+ - [دليل التثبيت الخاص بالمنصة](docs/ar/installation-platform-specific.md) - تعليمات التثبيت لأنظمة التشغيل المختلفة
92
+ - [دليل التكوين](docs/ar/configuration.md) - أمثلة تكوين اتصال قاعدة البيانات وأفضل الممارسات
93
+ - [دليل الاستخدام](docs/ar/usage.md) - سير العمل الأساسي وسيناريوهات الاستخدام الشائعة
94
+
95
+ ### التوثيق التقني
96
+ - [تصميم الهندسة](docs/ar/technical/architecture.md) - هندسة النظام والمكونات
97
+ - [هندسة الأمان](docs/ar/technical/security.md) - ميزات الأمان وآليات الحماية
98
+ - [دليل التطوير](docs/ar/technical/development.md) - جودة الكود وسير عمل التطوير
99
+ - [دليل الاختبار](docs/ar/technical/testing.md) - إطار الاختبار وأفضل الممارسات
100
+ - [تكامل SonarCloud](docs/ar/technical/sonarcloud-integration.md) - دليل تكامل SonarCloud والذكاء الاصطناعي
101
+
102
+ ### توثيق الأمثلة
103
+ - [أمثلة SQLite](docs/ar/examples/sqlite-examples.md) - أمثلة عمليات قاعدة بيانات SQLite
104
+ - [أمثلة PostgreSQL](docs/ar/examples/postgresql-examples.md) - أمثلة عمليات قاعدة بيانات PostgreSQL
105
+ - [أمثلة MySQL](docs/ar/examples/mysql-examples.md) - أمثلة عمليات قاعدة بيانات MySQL
106
+ - [تفاعلات LLM المتقدمة](docs/ar/examples/advanced-llm-interactions.md) - أمثلة تفاعل متقدمة مع LLM المختلفة
107
+
108
+ ### الوثائق متعددة اللغات
109
+ - **الإنجليزية** - [English Documentation](docs/en/)
110
+ - **الصينية** - [中文文档](docs/zh/)
111
+ - **الفرنسية** - [Documentation Française](docs/fr/)
112
+ - **الإسبانية** - [Documentación en Español](docs/es/)
113
+ - **الروسية** - [Документация на русском](docs/ru/)
114
+
115
+ ### الدعم والتعليقات
116
+ - [مشكلات GitHub](https://github.com/donghao1393/mcp-dbutils/issues) - الإبلاغ عن المشكلات أو طلب الميزات
117
+ - [Smithery](https://smithery.ai/server/@donghao1393/mcp-dbutils) - تثبيت وتحديثات مبسطة
118
+
119
+ ## تاريخ النجوم
120
+
121
+ [![مخطط تاريخ النجوم](https://starchart.cc/donghao1393/mcp-dbutils.svg?variant=adaptive)](https://starchart.cc/donghao1393/mcp-dbutils)
122
+
123
+ ## الترخيص
124
+
125
+ هذا المشروع مرخص بموجب ترخيص MIT - راجع ملف [LICENSE](LICENSE) للحصول على التفاصيل.
126
+
127
+ </div>
@@ -0,0 +1,118 @@
1
+ # MCP Database Utilities
2
+
3
+ <!-- Project Status Badges -->
4
+ [![Build Status](https://img.shields.io/github/workflow/status/donghao1393/mcp-dbutils/Quality%20Assurance?label=tests)](https://github.com/donghao1393/mcp-dbutils/actions)
5
+ [![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/donghao1393/bdd0a63ec2a816539ff8c136ceb41e48/raw/coverage.json)](https://github.com/donghao1393/mcp-dbutils/actions)
6
+ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=donghao1393_mcp-dbutils&metric=alert_status)](https://sonarcloud.io/dashboard?id=donghao1393_mcp-dbutils)
7
+
8
+ <!-- Version and Installation Badges -->
9
+ [![PyPI version](https://img.shields.io/pypi/v/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
10
+ [![PyPI downloads](https://img.shields.io/pypi/dm/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
11
+ [![Smithery](https://smithery.ai/badge/@donghao1393/mcp-dbutils)](https://smithery.ai/server/@donghao1393/mcp-dbutils)
12
+
13
+ <!-- Technical Specification Badges -->
14
+ [![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
15
+ [![License](https://img.shields.io/github/license/donghao1393/mcp-dbutils)](LICENSE)
16
+ [![GitHub Stars](https://img.shields.io/github/stars/donghao1393/mcp-dbutils?style=social)](https://github.com/donghao1393/mcp-dbutils/stargazers)
17
+
18
+ [中文](README.md) | [Français](README_FR.md) | [Español](README_ES.md) | [العربية](README_AR.md) | [Русский](README_RU.md) | [Documentation](#documentation)
19
+
20
+ ## Introduction
21
+
22
+ MCP Database Utilities is an all-in-one MCP service that enables your AI to do data analysis by accessing versatile types of database (SQLite, MySQL, PostgreSQL, and more) within a unified connection configuration in a safe way.
23
+
24
+ Think of it as a secure bridge between AI systems and your databases, allowing AI to read and analyze your data without direct database access or risking data modifications.
25
+
26
+ ### Key Features
27
+
28
+ - **Security First**: Strictly read-only operations, no direct database access, isolated connections, on-demand connectivity, automatic timeouts
29
+ - **Privacy Safeguards**: Local processing, minimal data exposure, credential protection, sensitive data masking
30
+ - **Multiple Database Support**: Connect to SQLite, MySQL, PostgreSQL with the same interface
31
+ - **Simple Configuration**: Single YAML file for all your database connections
32
+ - **Advanced Capabilities**: Table exploration, schema analysis, and query execution
33
+
34
+ > 🔒 **Security Note**: MCP Database Utilities is built with a security-first architecture, making it ideal for businesses, startups, and individuals who value data protection. Learn more about our [security architecture](docs/en/technical/security.md).
35
+
36
+ ## Quick Start
37
+
38
+ We offer multiple installation methods, including uvx, Docker, and Smithery. For detailed installation and configuration steps, see the [Installation Guide](docs/en/installation.md).
39
+
40
+ ### Basic Steps
41
+
42
+ 1. **Install**: Choose your preferred installation method ([detailed instructions](docs/en/installation.md))
43
+ 2. **Configure**: Create a YAML file with your database connection information ([configuration guide](docs/en/configuration.md))
44
+ 3. **Connect**: Add the configuration to your AI client
45
+ 4. **Use**: Start interacting with your databases ([usage guide](docs/en/usage.md))
46
+
47
+ ## Example Interactions
48
+
49
+ **You**: "Can you list all the tables in my my-postgres database?"
50
+
51
+ **AI**: "I'll check that for you. Here are the tables in your my-postgres database:
52
+ - customers
53
+ - products
54
+ - orders
55
+ - inventory
56
+ - employees"
57
+
58
+ **You**: "What does the customers table look like?"
59
+
60
+ **AI**: "The customers table has the following structure:
61
+ - id (integer, primary key)
62
+ - name (text)
63
+ - email (text)
64
+ - registration_date (date)
65
+ - last_purchase (date)
66
+ - total_spent (numeric)"
67
+
68
+ **You**: "How many customers made purchases in the last month?"
69
+
70
+ **AI**: "Let me run a query to find out... According to the data, 128 customers made purchases in the last month. The total value of these purchases was $25,437.82."
71
+
72
+ ## Available Tools
73
+
74
+ MCP Database Utilities provides several tools that your AI can use:
75
+
76
+ - **dbutils-list-connections**: Lists all available database connections in your configuration
77
+ - **dbutils-list-tables**: Lists all tables in a database
78
+ - **dbutils-run-query**: Executes a SQL query (SELECT only)
79
+ - **dbutils-get-stats**: Gets statistics about a table
80
+ - **dbutils-list-constraints**: Lists table constraints
81
+ - **dbutils-explain-query**: Gets query execution plan
82
+ - **dbutils-get-performance**: Gets database performance metrics
83
+ - **dbutils-analyze-query**: Analyzes queries for optimization
84
+
85
+
86
+
87
+ ## Documentation
88
+
89
+ ### Getting Started
90
+ - [Installation Guide](docs/en/installation.md) - Detailed installation steps and configuration instructions
91
+ - [Platform-Specific Installation Guide](docs/en/installation-platform-specific.md) - Installation instructions for different operating systems
92
+ - [Configuration Guide](docs/en/configuration.md) - Database connection configuration examples and best practices
93
+ - [Usage Guide](docs/en/usage.md) - Basic workflow and common usage scenarios
94
+
95
+ ### Technical Documentation
96
+ - [Architecture Design](docs/en/technical/architecture.md) - System architecture and components
97
+ - [Security Architecture](docs/en/technical/security.md) - Security features and protection mechanisms
98
+ - [Development Guide](docs/en/technical/development.md) - Code quality and development workflow
99
+ - [Testing Guide](docs/en/technical/testing.md) - Testing framework and best practices
100
+ - [SonarCloud Integration](docs/en/technical/sonarcloud-integration.md) - SonarCloud and AI integration guide
101
+
102
+ ### Example Documentation
103
+ - [SQLite Examples](docs/en/examples/sqlite-examples.md) - SQLite database operation examples
104
+ - [PostgreSQL Examples](docs/en/examples/postgresql-examples.md) - PostgreSQL database operation examples
105
+ - [MySQL Examples](docs/en/examples/mysql-examples.md) - MySQL database operation examples
106
+ - [Advanced LLM Interactions](docs/en/examples/advanced-llm-interactions.md) - Advanced interaction examples with various LLMs
107
+
108
+ ### Support & Feedback
109
+ - [GitHub Issues](https://github.com/donghao1393/mcp-dbutils/issues) - Report issues or request features
110
+ - [Smithery](https://smithery.ai/server/@donghao1393/mcp-dbutils) - Simplified installation and updates
111
+
112
+ ## Star History
113
+
114
+ [![Star History Chart](https://starchart.cc/donghao1393/mcp-dbutils.svg?variant=adaptive)](https://starchart.cc/donghao1393/mcp-dbutils)
115
+
116
+ ## License
117
+
118
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.