mcp-dbutils 0.16.1__tar.gz → 0.18.0__tar.gz

{mcp_dbutils-0.16.1 → mcp_dbutils-0.18.0}/.gitignore

@@ -1,5 +1,5 @@
 # Python
-docs/
+docs/local/
 __pycache__/
 *.py[cod]
 *$py.class

{mcp_dbutils-0.16.1 → mcp_dbutils-0.18.0}/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [0.18.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.17.0...v0.18.0) (2025-04-25)
+
+
+### Features
+
+* add dbutils-list-connections tool ([#68](https://github.com/donghao1393/mcp-dbutils/issues/68)) ([44ce9ac](https://github.com/donghao1393/mcp-dbutils/commit/44ce9ac9a63fcd43a0c817ee72b508380f36ba8d))
+
+# [0.17.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.16.1...v0.17.0) (2025-03-16)
+
+
+### Features
+
+* 添加本地SonarQube分析脚本 ([65326a3](https://github.com/donghao1393/mcp-dbutils/commit/65326a3aa3a61db353fd3c399a3c808e9a07e332))
+
 ## [0.16.1](https://github.com/donghao1393/mcp-dbutils/compare/v0.16.0...v0.16.1) (2025-03-15)
 
 

mcp_dbutils-0.18.0/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: mcp-dbutils
+Version: 0.18.0
+Summary: MCP Database Utilities Service
+Author: Dong Hao
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: mcp>=1.2.1
+Requires-Dist: mysql-connector-python>=8.2.0
+Requires-Dist: psycopg2-binary>=2.9.10
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: pyyaml>=6.0.2
+Provides-Extra: test
+Requires-Dist: aiosqlite>=0.19.0; extra == 'test'
+Requires-Dist: docker>=7.0.0; extra == 'test'
+Requires-Dist: pre-commit>=3.6.0; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
+Requires-Dist: pytest-docker>=2.0.0; extra == 'test'
+Requires-Dist: pytest>=7.0.0; extra == 'test'
+Requires-Dist: ruff>=0.3.0; extra == 'test'
+Requires-Dist: testcontainers>=3.7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# MCP 数据库工具
+
+<!-- 项目状态徽章 -->
+[![构建状态](https://img.shields.io/github/workflow/status/donghao1393/mcp-dbutils/Quality%20Assurance?label=tests)](https://github.com/donghao1393/mcp-dbutils/actions)
+[![覆盖率](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/donghao1393/bdd0a63ec2a816539ff8c136ceb41e48/raw/coverage.json)](https://github.com/donghao1393/mcp-dbutils/actions)
+[![质量门禁状态](https://sonarcloud.io/api/project_badges/measure?project=donghao1393_mcp-dbutils&metric=alert_status)](https://sonarcloud.io/dashboard?id=donghao1393_mcp-dbutils)
+
+<!-- 版本和安装徽章 -->
+[![PyPI 版本](https://img.shields.io/pypi/v/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
+[![PyPI 下载量](https://img.shields.io/pypi/dm/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
+[![Smithery](https://smithery.ai/badge/@donghao1393/mcp-dbutils)](https://smithery.ai/server/@donghao1393/mcp-dbutils)
+
+<!-- 技术规格徽章 -->
+[![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
+[![许可证](https://img.shields.io/github/license/donghao1393/mcp-dbutils)](LICENSE)
+[![GitHub 星标](https://img.shields.io/github/stars/donghao1393/mcp-dbutils?style=social)](https://github.com/donghao1393/mcp-dbutils/stargazers)
+
+[English](README_EN.md) | [文档导航](#文档导航)
+
+![Image](https://github.com/user-attachments/assets/26c4f1a1-7b19-4bdd-b9fd-34ad198b0ce3)
+
+## 简介
+
+MCP Database Utilities 是一个多功能的 MCP 服务，它使您的 AI 能够通过统一的连接配置安全地访问各种类型的数据库（SQLite、MySQL、PostgreSQL 等）进行数据分析。
+
+您可以将其视为 AI 系统和数据库之间的安全桥梁，允许 AI 在不直接访问数据库或冒数据修改风险的情况下读取和分析您的数据。
+
+### 核心特性
+
+- **安全优先**：严格只读操作，无直接数据库访问，隔离连接，按需连接，自动超时
+- **隐私保障**：本地处理，最小数据暴露，凭证保护，敏感数据屏蔽
+- **多数据库支持**：使用相同的接口连接 SQLite、MySQL、PostgreSQL
+- **简单配置**：所有数据库连接使用单个 YAML 文件
+- **高级功能**：表格浏览、架构分析和查询执行
+
+> 🔒 **安全说明**：MCP 数据库工具采用安全优先的架构设计，非常适合注重数据保护的企业、初创公司和个人用户。详细了解我们的[安全架构](docs/zh/technical/security.md)。
+
+## 快速入门
+
+我们提供了多种安装方式，包括 uvx、Docker 和 Smithery。详细的安装和配置步骤请参阅[安装指南](docs/zh/installation.md)。
+
+### 基本步骤
+
+1. **安装**：选择适合您的安装方式（[详细说明](docs/zh/installation.md)）
+2. **配置**：创建包含数据库连接信息的 YAML 文件（[配置指南](docs/zh/configuration.md)）
+3. **连接**：将配置添加到您的 AI 客户端
+4. **使用**：开始与您的数据库交互（[使用指南](docs/zh/usage.md)）
+
+### 示例交互
+
+**您**："能否列出我的数据库中的所有表？"
+
+**AI**："以下是您的数据库中的表：
+- customers（客户）
+- products（产品）
+- orders（订单）
+- inventory（库存）"
+
+**您**："customers 表的结构是什么样的？"
+
+**AI**："customers 表有以下结构：
+- id（整数，主键）
+- name（文本）
+- email（文本）
+- registration_date（日期）"
+
+## 文档导航
+
+### 入门指南
+- [安装指南](docs/zh/installation.md) - 详细的安装步骤和配置说明
+- [平台特定安装指南](docs/zh/installation-platform-specific.md) - 针对不同操作系统的安装说明
+- [配置指南](docs/zh/configuration.md) - 数据库连接配置示例和最佳实践
+- [使用指南](docs/zh/usage.md) - 基本操作流程和常见使用场景
+
+### 技术文档
+- [架构设计](docs/zh/technical/architecture.md) - 系统架构和组件说明
+- [安全架构](docs/zh/technical/security.md) - 安全特性和保护机制
+- [开发指南](docs/zh/technical/development.md) - 代码质量和开发流程
+- [测试指南](docs/zh/technical/testing.md) - 测试框架和最佳实践
+- [SonarCloud 集成](docs/zh/technical/sonarcloud-integration.md) - SonarCloud 与 AI 集成指南
+
+### 示例文档
+- [SQLite 示例](docs/zh/examples/sqlite-examples.md) - SQLite 数据库操作示例
+- [PostgreSQL 示例](docs/zh/examples/postgresql-examples.md) - PostgreSQL 数据库操作示例
+- [MySQL 示例](docs/zh/examples/mysql-examples.md) - MySQL 数据库操作示例
+- [高级 LLM 交互示例](docs/zh/examples/advanced-llm-interactions.md) - 与各类 LLM 的高级交互示例
+
+### 支持与反馈
+- [GitHub Issues](https://github.com/donghao1393/mcp-dbutils/issues) - 报告问题或请求功能
+- [Smithery](https://smithery.ai/server/@donghao1393/mcp-dbutils) - 简化安装和更新
+
+## 可用工具
+
+MCP 数据库工具提供了多种工具，使 AI 能够与您的数据库交互：
+
+- **dbutils-list-connections**：列出配置中的所有可用数据库连接
+- **dbutils-list-tables**：列出数据库中的所有表
+- **dbutils-run-query**：执行 SQL 查询（仅 SELECT）
+- **dbutils-get-stats**：获取表统计信息
+- **dbutils-list-constraints**：列出表约束
+- **dbutils-explain-query**：获取查询执行计划
+- **dbutils-get-performance**：获取数据库性能指标
+- **dbutils-analyze-query**：分析查询以进行优化
+
+有关这些工具的详细说明和使用示例，请参阅[使用指南](docs/zh/usage.md)。
+
+## 星标历史
+
+[![星标历史图表](https://starchart.cc/donghao1393/mcp-dbutils.svg?variant=adaptive)](https://starchart.cc/donghao1393/mcp-dbutils)
+
+## 许可证
+
+本项目采用 MIT 许可证 - 有关详细信息，请参阅 [LICENSE](LICENSE) 文件。

mcp_dbutils-0.18.0/README.md

@@ -0,0 +1,113 @@
+# MCP 数据库工具
+
+<!-- 项目状态徽章 -->
+[![构建状态](https://img.shields.io/github/workflow/status/donghao1393/mcp-dbutils/Quality%20Assurance?label=tests)](https://github.com/donghao1393/mcp-dbutils/actions)
+[![覆盖率](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/donghao1393/bdd0a63ec2a816539ff8c136ceb41e48/raw/coverage.json)](https://github.com/donghao1393/mcp-dbutils/actions)
+[![质量门禁状态](https://sonarcloud.io/api/project_badges/measure?project=donghao1393_mcp-dbutils&metric=alert_status)](https://sonarcloud.io/dashboard?id=donghao1393_mcp-dbutils)
+
+<!-- 版本和安装徽章 -->
+[![PyPI 版本](https://img.shields.io/pypi/v/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
+[![PyPI 下载量](https://img.shields.io/pypi/dm/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
+[![Smithery](https://smithery.ai/badge/@donghao1393/mcp-dbutils)](https://smithery.ai/server/@donghao1393/mcp-dbutils)
+
+<!-- 技术规格徽章 -->
+[![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
+[![许可证](https://img.shields.io/github/license/donghao1393/mcp-dbutils)](LICENSE)
+[![GitHub 星标](https://img.shields.io/github/stars/donghao1393/mcp-dbutils?style=social)](https://github.com/donghao1393/mcp-dbutils/stargazers)
+
+[English](README_EN.md) | [文档导航](#文档导航)
+
+![Image](https://github.com/user-attachments/assets/26c4f1a1-7b19-4bdd-b9fd-34ad198b0ce3)
+
+## 简介
+
+MCP Database Utilities 是一个多功能的 MCP 服务，它使您的 AI 能够通过统一的连接配置安全地访问各种类型的数据库（SQLite、MySQL、PostgreSQL 等）进行数据分析。
+
+您可以将其视为 AI 系统和数据库之间的安全桥梁，允许 AI 在不直接访问数据库或冒数据修改风险的情况下读取和分析您的数据。
+
+### 核心特性
+
+- **安全优先**：严格只读操作，无直接数据库访问，隔离连接，按需连接，自动超时
+- **隐私保障**：本地处理，最小数据暴露，凭证保护，敏感数据屏蔽
+- **多数据库支持**：使用相同的接口连接 SQLite、MySQL、PostgreSQL
+- **简单配置**：所有数据库连接使用单个 YAML 文件
+- **高级功能**：表格浏览、架构分析和查询执行
+
+> 🔒 **安全说明**：MCP 数据库工具采用安全优先的架构设计，非常适合注重数据保护的企业、初创公司和个人用户。详细了解我们的[安全架构](docs/zh/technical/security.md)。
+
+## 快速入门
+
+我们提供了多种安装方式，包括 uvx、Docker 和 Smithery。详细的安装和配置步骤请参阅[安装指南](docs/zh/installation.md)。
+
+### 基本步骤
+
+1. **安装**：选择适合您的安装方式（[详细说明](docs/zh/installation.md)）
+2. **配置**：创建包含数据库连接信息的 YAML 文件（[配置指南](docs/zh/configuration.md)）
+3. **连接**：将配置添加到您的 AI 客户端
+4. **使用**：开始与您的数据库交互（[使用指南](docs/zh/usage.md)）
+
+### 示例交互
+
+**您**："能否列出我的数据库中的所有表？"
+
+**AI**："以下是您的数据库中的表：
+- customers（客户）
+- products（产品）
+- orders（订单）
+- inventory（库存）"
+
+**您**："customers 表的结构是什么样的？"
+
+**AI**："customers 表有以下结构：
+- id（整数，主键）
+- name（文本）
+- email（文本）
+- registration_date（日期）"
+
+## 文档导航
+
+### 入门指南
+- [安装指南](docs/zh/installation.md) - 详细的安装步骤和配置说明
+- [平台特定安装指南](docs/zh/installation-platform-specific.md) - 针对不同操作系统的安装说明
+- [配置指南](docs/zh/configuration.md) - 数据库连接配置示例和最佳实践
+- [使用指南](docs/zh/usage.md) - 基本操作流程和常见使用场景
+
+### 技术文档
+- [架构设计](docs/zh/technical/architecture.md) - 系统架构和组件说明
+- [安全架构](docs/zh/technical/security.md) - 安全特性和保护机制
+- [开发指南](docs/zh/technical/development.md) - 代码质量和开发流程
+- [测试指南](docs/zh/technical/testing.md) - 测试框架和最佳实践
+- [SonarCloud 集成](docs/zh/technical/sonarcloud-integration.md) - SonarCloud 与 AI 集成指南
+
+### 示例文档
+- [SQLite 示例](docs/zh/examples/sqlite-examples.md) - SQLite 数据库操作示例
+- [PostgreSQL 示例](docs/zh/examples/postgresql-examples.md) - PostgreSQL 数据库操作示例
+- [MySQL 示例](docs/zh/examples/mysql-examples.md) - MySQL 数据库操作示例
+- [高级 LLM 交互示例](docs/zh/examples/advanced-llm-interactions.md) - 与各类 LLM 的高级交互示例
+
+### 支持与反馈
+- [GitHub Issues](https://github.com/donghao1393/mcp-dbutils/issues) - 报告问题或请求功能
+- [Smithery](https://smithery.ai/server/@donghao1393/mcp-dbutils) - 简化安装和更新
+
+## 可用工具
+
+MCP 数据库工具提供了多种工具，使 AI 能够与您的数据库交互：
+
+- **dbutils-list-connections**：列出配置中的所有可用数据库连接
+- **dbutils-list-tables**：列出数据库中的所有表
+- **dbutils-run-query**：执行 SQL 查询（仅 SELECT）
+- **dbutils-get-stats**：获取表统计信息
+- **dbutils-list-constraints**：列出表约束
+- **dbutils-explain-query**：获取查询执行计划
+- **dbutils-get-performance**：获取数据库性能指标
+- **dbutils-analyze-query**：分析查询以进行优化
+
+有关这些工具的详细说明和使用示例，请参阅[使用指南](docs/zh/usage.md)。
+
+## 星标历史
+
+[![星标历史图表](https://starchart.cc/donghao1393/mcp-dbutils.svg?variant=adaptive)](https://starchart.cc/donghao1393/mcp-dbutils)
+
+## 许可证
+
+本项目采用 MIT 许可证 - 有关详细信息，请参阅 [LICENSE](LICENSE) 文件。

mcp_dbutils-0.18.0/README_EN.md

@@ -0,0 +1,118 @@
+# MCP Database Utilities
+
+<!-- Project Status Badges -->
+[![Build Status](https://img.shields.io/github/workflow/status/donghao1393/mcp-dbutils/Quality%20Assurance?label=tests)](https://github.com/donghao1393/mcp-dbutils/actions)
+[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/donghao1393/bdd0a63ec2a816539ff8c136ceb41e48/raw/coverage.json)](https://github.com/donghao1393/mcp-dbutils/actions)
+[![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)
+
+<!-- Version and Installation Badges -->
+[![PyPI version](https://img.shields.io/pypi/v/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
+[![PyPI downloads](https://img.shields.io/pypi/dm/mcp-dbutils)](https://pypi.org/project/mcp-dbutils/)
+[![Smithery](https://smithery.ai/badge/@donghao1393/mcp-dbutils)](https://smithery.ai/server/@donghao1393/mcp-dbutils)
+
+<!-- Technical Specification Badges -->
+[![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
+[![License](https://img.shields.io/github/license/donghao1393/mcp-dbutils)](LICENSE)
+[![GitHub Stars](https://img.shields.io/github/stars/donghao1393/mcp-dbutils?style=social)](https://github.com/donghao1393/mcp-dbutils/stargazers)
+
+[中文文档](README.md) | [Documentation](#documentation)
+
+## Introduction
+
+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.
+
+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.
+
+### Key Features
+
+- **Security First**: Strictly read-only operations, no direct database access, isolated connections, on-demand connectivity, automatic timeouts
+- **Privacy Safeguards**: Local processing, minimal data exposure, credential protection, sensitive data masking
+- **Multiple Database Support**: Connect to SQLite, MySQL, PostgreSQL with the same interface
+- **Simple Configuration**: Single YAML file for all your database connections
+- **Advanced Capabilities**: Table exploration, schema analysis, and query execution
+
+> 🔒 **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).
+
+## Quick Start
+
+We offer multiple installation methods, including uvx, Docker, and Smithery. For detailed installation and configuration steps, see the [Installation Guide](docs/en/installation.md).
+
+### Basic Steps
+
+1. **Install**: Choose your preferred installation method ([detailed instructions](docs/en/installation.md))
+2. **Configure**: Create a YAML file with your database connection information ([configuration guide](docs/en/configuration.md))
+3. **Connect**: Add the configuration to your AI client
+4. **Use**: Start interacting with your databases ([usage guide](docs/en/usage.md))
+
+## Example Interactions
+
+**You**: "Can you list all the tables in my my-postgres database?"
+
+**AI**: "I'll check that for you. Here are the tables in your my-postgres database:
+- customers
+- products
+- orders
+- inventory
+- employees"
+
+**You**: "What does the customers table look like?"
+
+**AI**: "The customers table has the following structure:
+- id (integer, primary key)
+- name (text)
+- email (text)
+- registration_date (date)
+- last_purchase (date)
+- total_spent (numeric)"
+
+**You**: "How many customers made purchases in the last month?"
+
+**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."
+
+## Available Tools
+
+MCP Database Utilities provides several tools that your AI can use:
+
+- **dbutils-list-connections**: Lists all available database connections in your configuration
+- **dbutils-list-tables**: Lists all tables in a database
+- **dbutils-run-query**: Executes a SQL query (SELECT only)
+- **dbutils-get-stats**: Gets statistics about a table
+- **dbutils-list-constraints**: Lists table constraints
+- **dbutils-explain-query**: Gets query execution plan
+- **dbutils-get-performance**: Gets database performance metrics
+- **dbutils-analyze-query**: Analyzes queries for optimization
+
+
+
+## Documentation
+
+### Getting Started
+- [Installation Guide](docs/en/installation.md) - Detailed installation steps and configuration instructions
+- [Platform-Specific Installation Guide](docs/en/installation-platform-specific.md) - Installation instructions for different operating systems
+- [Configuration Guide](docs/en/configuration.md) - Database connection configuration examples and best practices
+- [Usage Guide](docs/en/usage.md) - Basic workflow and common usage scenarios
+
+### Technical Documentation
+- [Architecture Design](docs/en/technical/architecture.md) - System architecture and components
+- [Security Architecture](docs/en/technical/security.md) - Security features and protection mechanisms
+- [Development Guide](docs/en/technical/development.md) - Code quality and development workflow
+- [Testing Guide](docs/en/technical/testing.md) - Testing framework and best practices
+- [SonarCloud Integration](docs/en/technical/sonarcloud-integration.md) - SonarCloud and AI integration guide
+
+### Example Documentation
+- [SQLite Examples](docs/en/examples/sqlite-examples.md) - SQLite database operation examples
+- [PostgreSQL Examples](docs/en/examples/postgresql-examples.md) - PostgreSQL database operation examples
+- [MySQL Examples](docs/en/examples/mysql-examples.md) - MySQL database operation examples
+- [Advanced LLM Interactions](docs/en/examples/advanced-llm-interactions.md) - Advanced interaction examples with various LLMs
+
+### Support & Feedback
+- [GitHub Issues](https://github.com/donghao1393/mcp-dbutils/issues) - Report issues or request features
+- [Smithery](https://smithery.ai/server/@donghao1393/mcp-dbutils) - Simplified installation and updates
+
+## Star History
+
+[![Star History Chart](https://starchart.cc/donghao1393/mcp-dbutils.svg?variant=adaptive)](https://starchart.cc/donghao1393/mcp-dbutils)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

mcp_dbutils-0.18.0/docs/document-consistency-check.md

@@ -0,0 +1,87 @@
+# 文档一致性检查报告
+
+本报告记录了对 MCP 数据库工具文档的一致性检查结果，旨在确保所有文档符合统一的标准和风格。
+
+## 检查标准
+
+检查基于以下标准：
+
+1. **格式一致性**
+   - 标题层级使用（# 一级标题，## 二级标题，等）
+   - 代码块使用 ```语言 格式
+   - 列表格式统一（有序/无序）
+   - 表格格式统一
+
+2. **术语一致性**
+   - 产品名称：统一使用"MCP 数据库工具"或"MCP Database Utilities"
+   - 技术术语：确保相同概念使用相同术语
+
+3. **风格一致性**
+   - 语气：保持专业、清晰、简洁
+   - 表达方式：使用主动语态
+   - 示例风格：保持一致的示例格式
+
+4. **链接一致性**
+   - 确保所有内部链接有效
+   - 确保所有外部链接有效
+   - 链接文本描述性强
+
+5. **内容完整性**
+   - 中英文文档内容对应
+   - 文档覆盖所有必要信息
+
+## 检查结果
+
+### 中文文档
+
+| 文档 | 格式一致性 | 术语一致性 | 风格一致性 | 链接一致性 | 内容完整性 | 需要改进的地方 |
+|------|------------|------------|------------|------------|------------|----------------|
+| docs/zh/configuration.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/installation.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/usage.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/technical/architecture.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/technical/security.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/technical/development.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/technical/testing.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/technical/sonarcloud-integration.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/examples/sqlite-examples.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/examples/postgresql-examples.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/zh/examples/mysql-examples.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+
+### 英文文档
+
+| 文档 | 格式一致性 | 术语一致性 | 风格一致性 | 链接一致性 | 内容完整性 | 需要改进的地方 |
+|------|------------|------------|------------|------------|------------|----------------|
+| docs/en/configuration.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/installation.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/usage.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/technical/architecture.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/technical/security.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/technical/development.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/technical/testing.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/technical/sonarcloud-integration.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/examples/sqlite-examples.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/examples/postgresql-examples.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+| docs/en/examples/mysql-examples.md | ✅ | ✅ | ✅ | ✅ | ✅ | 无 |
+
+## 总体评估
+
+经过检查，我们的文档整体一致性良好。在最近的文档重组过程中，我们已经解决了大部分一致性问题，包括：
+
+1. 统一了文档结构，按照语言和文档类型进行分类
+2. 统一了文档格式，包括标题层级、代码块、列表和表格格式
+3. 统一了术语使用，确保相同概念使用相同术语
+4. 统一了文档风格，保持专业、清晰、简洁的语气
+5. 确保了所有链接的有效性
+6. 确保了中英文文档内容的对应性
+
+## 建议
+
+虽然当前文档已经具有良好的一致性，但我们仍可以考虑以下改进：
+
+1. **添加文档版本信息**：在每个文档顶部添加版本号和最后更新日期
+2. **添加视觉元素**：在适当的地方添加图表、流程图等视觉元素，提升文档可读性
+3. **添加平台特定指南**：为不同操作系统创建专门的安装和配置指南
+4. **丰富交互示例**：添加更多与各类 LLM 交互的示例，展示产品的潜力
+
+这些改进将在后续工作中逐步实施。

mcp_dbutils-0.18.0/docs/document-version-history.md

@@ -0,0 +1,69 @@
+# 文档版本历史
+
+本文件记录了 MCP 数据库工具文档的版本历史和重要更新。
+
+## 版本命名规则
+
+文档版本使用以下格式：`vX.Y.Z`，其中：
+
+- `X`：主版本号，表示重大结构或内容变更
+- `Y`：次版本号，表示功能添加或重要内容更新
+- `Z`：修订版本号，表示错误修复或小幅内容改进
+
+## 版本历史
+
+### v1.0.0 (2024-04-24)
+
+**主要更新**：
+- 完成文档重组，按照语言（中英文）和文档类型进行分类
+- 创建了详细的 PostgreSQL 和 MySQL 示例文档
+- 整合 STYLE_GUIDE.md 到开发指南中
+- 将 technical-guide.md 的内容分解到各个技术文档中
+- 处理 SonarCloud 集成文档，创建中英文版本
+- 更新 README 中的文档链接
+
+**新增文档**：
+- docs/zh/examples/postgresql-examples.md
+- docs/zh/examples/mysql-examples.md
+- docs/en/examples/postgresql-examples.md
+- docs/en/examples/mysql-examples.md
+- docs/zh/technical/sonarcloud-integration.md
+- docs/en/technical/sonarcloud-integration.md
+
+**删除文档**：
+- docs/STYLE_GUIDE.md
+- docs/technical-guide.md
+- docs/configuration-examples.md
+- docs/sonarcloud-ai-integration.md
+
+### v1.1.0 (2024-04-25)
+
+**主要更新**：
+- 添加平台特定安装指南，针对不同操作系统提供详细安装说明
+- 创建高级 LLM 交互示例文档，展示与各类 LLM 的交互潜力
+- 进行文档一致性检查，确保所有文档符合统一标准
+- 实施文档版本控制，添加版本信息和更新历史
+- 更新 README 中的文档链接
+
+**新增文档**：
+- docs/zh/installation-platform-specific.md
+- docs/en/installation-platform-specific.md
+- docs/zh/examples/advanced-llm-interactions.md
+- docs/en/examples/advanced-llm-interactions.md
+- docs/document-consistency-check.md
+- docs/document-version-history.md
+
+## 文档维护指南
+
+### 更新文档版本
+
+当对文档进行更新时，请遵循以下步骤：
+
+1. 确定更新的性质（主要结构变更、功能添加或错误修复）
+2. 根据更新性质，增加相应的版本号
+3. 在本文件中添加新版本的条目，记录主要更新内容和变更的文件
+4. 在更新的文档顶部更新版本号和最后更新日期
+
+### 文档版本与软件版本的关系
+
+文档版本与软件版本保持独立，但应在文档中明确说明其适用的软件版本范围。当软件发布新版本时，应相应地更新文档，并在版本历史中注明。