mcp-dbutils 0.9.0__tar.gz → 0.10.2__tar.gz

{mcp_dbutils-0.9.0 → mcp_dbutils-0.10.2}/.github/workflows/release.yml

@@ -2,8 +2,7 @@ name: Release
 
 on:
   push:
-    branches:
-      - main
+    branches: [ main ]
 
 jobs:
   release:
@@ -15,6 +14,8 @@ jobs:
     permissions:
       id-token: write
       contents: write
+      issues: write
+      pull-requests: write
 
     steps:
       - uses: actions/checkout@v4
@@ -26,24 +27,25 @@ jobs:
         with:
           python-version: '3.10'
 
-      - name: Install tools
+      - name: Install uv
         run: |
           curl -LsSf https://astral.sh/uv/install.sh | sh
           echo "$HOME/.cargo/bin" >> $GITHUB_PATH
 
-      - name: Determine Version and Create Release
-        id: version
-        uses: python-semantic-release/python-semantic-release@master
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          build: false
+          node-version: 'lts/*'
 
-      - name: Build Package
-        if: steps.version.outputs.released == 'true'
+      - name: Install semantic-release
         run: |
-          which uv
-          uv build
-        
+          npm install -g semantic-release @semantic-release/git @semantic-release/changelog @semantic-release/exec
+
+      - name: Release
+        id: semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release
+
       - name: Publish to PyPI
-        if: steps.version.outputs.released == 'true'
         uses: pypa/gh-action-pypi-publish@release/v1

mcp_dbutils-0.10.2/.releaserc.json

@@ -0,0 +1,26 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    ["@semantic-release/exec", {
+      "verifyConditionsCmd": "uv --version",
+      "prepareCmd": "sed -i.bak 's/version = \".*\"/version = \"${nextRelease.version}\"/g' pyproject.toml && rm -f pyproject.toml.bak",
+      "publishCmd": "uv build"
+    }],
+    ["@semantic-release/git", {
+      "assets": [
+        "pyproject.toml",
+        "CHANGELOG.md"
+      ],
+      "message": "chore(release): ${nextRelease.version}\n\n${nextRelease.notes}"
+    }],
+    ["@semantic-release/github", {
+      "assets": [
+        {"path": "dist/*.whl", "label": "Python Wheel ${nextRelease.version}"},
+        {"path": "dist/*.tar.gz", "label": "Source Distribution ${nextRelease.version}"}
+      ]
+    }]
+  ]
+}

{mcp_dbutils-0.9.0 → mcp_dbutils-0.10.2}/CHANGELOG.md

@@ -1,6 +1,45 @@
+## [0.10.2](https://github.com/donghao1393/mcp-dbutils/compare/v0.10.1...v0.10.2) (2025-03-13)
+
+
+### Bug Fixes
+
+* remove conditional check for PyPI publishing ([e714ef8](https://github.com/donghao1393/mcp-dbutils/commit/e714ef89db8dc35eca1a5c2f09f240dee94192eb))
+
+## [0.10.1](https://github.com/donghao1393/mcp-dbutils/compare/v0.10.0...v0.10.1) (2025-03-13)
+
+
+### Bug Fixes
+
+* update verifyConditionsCmd in semantic-release config ([4271476](https://github.com/donghao1393/mcp-dbutils/commit/42714761d5d8bbbd39b9bae2aa550e1d06aa351c))
+
 # CHANGELOG
 
 
+## v0.10.0 (2025-03-12)
+
+### Features
+
+- Enhance database configuration with SSL support
+  ([#22](https://github.com/donghao1393/mcp-dbutils/pull/22),
+  [`4ea4d0b`](https://github.com/donghao1393/mcp-dbutils/commit/4ea4d0b5deb51b8e9202839bd7a8cd5f71463c88))
+
+* feat: enhance database configuration with SSL support
+
+- Replace jdbc_url with url for better clarity - Add dedicated SSL configuration support - Update
+  documentation and examples - Update test cases
+
+BREAKING CHANGE: Remove jdbc_url support as it was just added and not yet in production use
+
+* docs: update documentation for SSL support and URL configuration
+
+- Add SSL configuration examples - Update configuration format examples - Add configuration
+  documentation in both English and Chinese - Remove JDBC related content
+
+### Breaking Changes
+
+- Remove jdbc_url support as it was just added and not yet in production use
+
+
 ## v0.9.0 (2025-03-09)
 
 ### Documentation

{mcp_dbutils-0.9.0 → mcp_dbutils-0.10.2}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: mcp-dbutils
-Version: 0.9.0
+Version: 0.10.2
 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
@@ -32,7 +33,7 @@ Description-Content-Type: text/markdown
 [中文文档](README_CN.md)
 
 ## Overview
-MCP Database Utilities is a unified database access service that supports multiple database types (PostgreSQL and SQLite). Through its abstraction layer design, it provides a simple and unified database operation interface for MCP servers.
+MCP Database Utilities is a unified database access service that supports multiple database types (PostgreSQL, SQLite, and MySQL). Through its abstraction layer design, it provides a simple and unified database operation interface for MCP servers.
 
 ## Features
 - Unified database access interface
@@ -42,6 +43,7 @@ MCP Database Utilities is a unified database access service that supports multip
 - Database tables listing via MCP tools
 - Intelligent connection management and resource cleanup
 - Debug mode support
+- SSL/TLS connection support for PostgreSQL and MySQL
 
 ## Installation and Configuration
 
@@ -143,54 +145,138 @@ Add to Claude configuration:
 - Python 3.10+
 - PostgreSQL (optional)
 - SQLite3 (optional)
+- MySQL (optional)
 
 ### Configuration File
-The project requires a YAML configuration file, specified via the `--config` parameter. Configuration example:
+The project requires a YAML configuration file, specified via the `--config` parameter. Configuration examples:
 
 ```yaml
 connections:
-  # Standard PostgreSQL configuration example
-  my_postgres:
+  # SQLite configuration examples
+  dev-db:
+    type: sqlite
+    path: /path/to/dev.db
+    # Password is optional
+    password: 
+
+  # PostgreSQL standard configuration
+  test-db:
     type: postgres
-    dbname: test_db
-    user: postgres
-    password: secret
-    host: host.docker.internal  # For Mac/Windows
-    # host: 172.17.0.1         # For Linux (docker0 IP)
+    host: postgres.example.com
     port: 5432
+    dbname: test_db
+    user: test_user
+    password: test_pass
 
-  # PostgreSQL with JDBC URL example
-  my_postgres_jdbc:
+  # PostgreSQL URL configuration with SSL
+  prod-db:
     type: postgres
-    jdbc_url: jdbc:postgresql://host.docker.internal:5432/test_db
-    user: postgres            # Credentials must be provided separately
-    password: secret          # Not included in JDBC URL for security
-
-  # SQLite standard configuration
-  my_sqlite:
-    type: sqlite
-    path: /app/sqlite.db       # Database file path
-    password: optional_password # optional
-
-  # SQLite with JDBC URL configuration
-  my_sqlite_jdbc:
-    type: sqlite
-    jdbc_url: jdbc:sqlite:/app/data.db?mode=ro&cache=shared  # Supports query parameters
-    password: optional_password    # Provided separately for security
+    url: postgresql://postgres.example.com:5432/prod-db?sslmode=verify-full
+    user: prod_user
+    password: prod_pass
+    
+  # PostgreSQL full SSL configuration example
+  secure-db:
+    type: postgres
+    host: secure-db.example.com
+    port: 5432
+    dbname: secure_db
+    user: secure_user
+    password: secure_pass
+    ssl:
+      mode: verify-full  # disable/require/verify-ca/verify-full
+      cert: /path/to/client-cert.pem
+      key: /path/to/client-key.pem
+      root: /path/to/root.crt
+      
+  # MySQL standard configuration
+  sandbox-mysql:
+    type: mysql
+    host: localhost
+    port: 3306
+    database: sandbox_db
+    user: sandbox_user
+    password: sandbox_pass
+    charset: utf8mb4
+
+  # MySQL URL configuration
+  integration-mysql:
+    type: mysql
+    url: mysql://mysql.example.com:3306/integration_db?charset=utf8mb4
+    user: integration_user
+    password: integration_pass
+    
+  # MySQL with SSL configuration
+  secure-mysql:
+    type: mysql
+    host: secure-mysql.example.com
+    port: 3306
+    database: secure_db
+    user: secure_user
+    password: secure_pass
+    charset: utf8mb4
+    ssl:
+      mode: verify_identity
+      ca: /path/to/ca.pem
+      cert: /path/to/client-cert.pem
+      key: /path/to/client-key.pem
 ```
 
-The configuration supports JDBC URL format for both PostgreSQL and SQLite:
-
-PostgreSQL:
-1. Standard configuration with individual parameters
-2. JDBC URL configuration with separate credentials
-
-SQLite:
-1. Standard configuration with path parameter
-2. JDBC URL configuration with query parameters support:
-   - mode=ro: Read-only mode
-   - cache=shared: Shared cache mode
-   - Other SQLite URI parameters
+Database SSL Configuration Options:
+
+PostgreSQL SSL Configuration:
+1. Using URL parameters:
+   ```
+   postgresql://host:port/dbname?sslmode=verify-full&sslcert=/path/to/cert.pem
+   ```
+2. Using dedicated SSL configuration section:
+   ```yaml
+   ssl:
+     mode: verify-full  # SSL verification mode
+     cert: /path/to/cert.pem      # Client certificate
+     key: /path/to/key.pem        # Client private key
+     root: /path/to/root.crt      # CA certificate
+   ```
+
+PostgreSQL SSL Modes:
+- disable: No SSL
+- require: Use SSL but no certificate verification
+- verify-ca: Verify server certificate is signed by trusted CA
+- verify-full: Verify server certificate and hostname match
+
+MySQL SSL Configuration:
+1. Using URL parameters:
+   ```
+   mysql://host:port/dbname?ssl-mode=verify_identity&ssl-ca=/path/to/ca.pem
+   ```
+2. Using dedicated SSL configuration section:
+   ```yaml
+   ssl:
+     mode: verify_identity  # SSL verification mode
+     ca: /path/to/ca.pem         # CA certificate
+     cert: /path/to/cert.pem     # Client certificate
+     key: /path/to/key.pem       # Client private key
+   ```
+
+MySQL SSL Modes:
+- disabled: No SSL
+- preferred: Use SSL if available, but allow unencrypted connection
+- required: Always use SSL, but don't verify server certificate
+- verify_ca: Verify server certificate is signed by trusted CA
+- verify_identity: Verify server certificate and hostname match
+
+SQLite Configuration Options:
+1. Basic configuration with path:
+   ```yaml
+   type: sqlite
+   path: /path/to/db.sqlite
+   password: optional_password  # Optional encryption
+   ```
+2. Using URI parameters:
+   ```yaml
+   type: sqlite
+   path: /path/to/db.sqlite?mode=ro&cache=shared
+   ```
 
 ### Debug Mode
 Set environment variable `MCP_DEBUG=1` to enable debug mode for detailed logging output.
@@ -207,12 +293,15 @@ graph TD
     DatabaseHandler[Database Handler]
     PostgresHandler[PostgreSQL Handler]
     SQLiteHandler[SQLite Handler]
+    MySQLHandler[MySQL Handler]
     DatabaseServer --> DatabaseHandler
     DatabaseHandler --> PostgresHandler
     DatabaseHandler --> SQLiteHandler
+    DatabaseHandler --> MySQLHandler
   end
   PostgresHandler --> PostgreSQL[(PostgreSQL)]
   SQLiteHandler --> SQLite[(SQLite)]
+  MySQLHandler --> MySQL[(MySQL)]
 ```
 
 The abstraction layer design is the core architectural concept in MCP Database Utilities. Just like a universal remote control that works with different devices, users only need to know the basic operations without understanding the underlying complexities.
@@ -224,7 +313,7 @@ The abstraction layer design is the core architectural concept in MCP Database U
 
 #### 2. Unified Interface Design
 - DatabaseHandler abstract class defines unified operation interfaces
-- All specific database implementations (PostgreSQL/SQLite) follow the same interface
+- All specific database implementations (PostgreSQL/SQLite/MySQL) follow the same interface
 - Users interact with different databases in the same way
 
 #### 3. Configuration and Implementation Separation
@@ -241,7 +330,7 @@ The abstraction layer design is the core architectural concept in MCP Database U
 2. DatabaseHandler
    - Abstract base class defining unified interface
    - Includes get_tables(), get_schema(), execute_query(), etc.
-   - Implemented by PostgreSQL and SQLite handlers
+   - Implemented by PostgreSQL, SQLite, and MySQL handlers
 
 3. Configuration System
    - YAML-based configuration file
@@ -364,6 +453,13 @@ Provides SQLite-specific features:
 - URI scheme support
 - Password protection support (optional)
 
+### MySQL Implementation
+Provides MySQL-specific features:
+- Remote connection support
+- Character set configuration
+- SSL/TLS secure connection
+- URL and standard connection methods
+
 ## Contributing
 Contributions are welcome! Here's how you can help:
 
@@ -383,7 +479,6 @@ For detailed guidelines, see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
 - [MCP Servers](https://github.com/modelcontextprotocol/servers) for inspiration and demonstration
 - AI Editors:
   * [Claude Desktop](https://claude.ai/download)
-  * [5ire](https://5ire.app/)
   * [Cline](https://cline.bot)
 - [Model Context Protocol](https://modelcontextprotocol.io/) for comprehensive interfaces
 

{mcp_dbutils-0.9.0 → mcp_dbutils-0.10.2}/README.md

@@ -10,7 +10,7 @@
 [中文文档](README_CN.md)
 
 ## Overview
-MCP Database Utilities is a unified database access service that supports multiple database types (PostgreSQL and SQLite). Through its abstraction layer design, it provides a simple and unified database operation interface for MCP servers.
+MCP Database Utilities is a unified database access service that supports multiple database types (PostgreSQL, SQLite, and MySQL). Through its abstraction layer design, it provides a simple and unified database operation interface for MCP servers.
 
 ## Features
 - Unified database access interface
@@ -20,6 +20,7 @@ MCP Database Utilities is a unified database access service that supports multip
 - Database tables listing via MCP tools
 - Intelligent connection management and resource cleanup
 - Debug mode support
+- SSL/TLS connection support for PostgreSQL and MySQL
 
 ## Installation and Configuration
 
@@ -121,54 +122,138 @@ Add to Claude configuration:
 - Python 3.10+
 - PostgreSQL (optional)
 - SQLite3 (optional)
+- MySQL (optional)
 
 ### Configuration File
-The project requires a YAML configuration file, specified via the `--config` parameter. Configuration example:
+The project requires a YAML configuration file, specified via the `--config` parameter. Configuration examples:
 
 ```yaml
 connections:
-  # Standard PostgreSQL configuration example
-  my_postgres:
+  # SQLite configuration examples
+  dev-db:
+    type: sqlite
+    path: /path/to/dev.db
+    # Password is optional
+    password: 
+
+  # PostgreSQL standard configuration
+  test-db:
     type: postgres
-    dbname: test_db
-    user: postgres
-    password: secret
-    host: host.docker.internal  # For Mac/Windows
-    # host: 172.17.0.1         # For Linux (docker0 IP)
+    host: postgres.example.com
     port: 5432
+    dbname: test_db
+    user: test_user
+    password: test_pass
 
-  # PostgreSQL with JDBC URL example
-  my_postgres_jdbc:
+  # PostgreSQL URL configuration with SSL
+  prod-db:
     type: postgres
-    jdbc_url: jdbc:postgresql://host.docker.internal:5432/test_db
-    user: postgres            # Credentials must be provided separately
-    password: secret          # Not included in JDBC URL for security
-
-  # SQLite standard configuration
-  my_sqlite:
-    type: sqlite
-    path: /app/sqlite.db       # Database file path
-    password: optional_password # optional
-
-  # SQLite with JDBC URL configuration
-  my_sqlite_jdbc:
-    type: sqlite
-    jdbc_url: jdbc:sqlite:/app/data.db?mode=ro&cache=shared  # Supports query parameters
-    password: optional_password    # Provided separately for security
+    url: postgresql://postgres.example.com:5432/prod-db?sslmode=verify-full
+    user: prod_user
+    password: prod_pass
+    
+  # PostgreSQL full SSL configuration example
+  secure-db:
+    type: postgres
+    host: secure-db.example.com
+    port: 5432
+    dbname: secure_db
+    user: secure_user
+    password: secure_pass
+    ssl:
+      mode: verify-full  # disable/require/verify-ca/verify-full
+      cert: /path/to/client-cert.pem
+      key: /path/to/client-key.pem
+      root: /path/to/root.crt
+      
+  # MySQL standard configuration
+  sandbox-mysql:
+    type: mysql
+    host: localhost
+    port: 3306
+    database: sandbox_db
+    user: sandbox_user
+    password: sandbox_pass
+    charset: utf8mb4
+
+  # MySQL URL configuration
+  integration-mysql:
+    type: mysql
+    url: mysql://mysql.example.com:3306/integration_db?charset=utf8mb4
+    user: integration_user
+    password: integration_pass
+    
+  # MySQL with SSL configuration
+  secure-mysql:
+    type: mysql
+    host: secure-mysql.example.com
+    port: 3306
+    database: secure_db
+    user: secure_user
+    password: secure_pass
+    charset: utf8mb4
+    ssl:
+      mode: verify_identity
+      ca: /path/to/ca.pem
+      cert: /path/to/client-cert.pem
+      key: /path/to/client-key.pem
 ```
 
-The configuration supports JDBC URL format for both PostgreSQL and SQLite:
-
-PostgreSQL:
-1. Standard configuration with individual parameters
-2. JDBC URL configuration with separate credentials
-
-SQLite:
-1. Standard configuration with path parameter
-2. JDBC URL configuration with query parameters support:
-   - mode=ro: Read-only mode
-   - cache=shared: Shared cache mode
-   - Other SQLite URI parameters
+Database SSL Configuration Options:
+
+PostgreSQL SSL Configuration:
+1. Using URL parameters:
+   ```
+   postgresql://host:port/dbname?sslmode=verify-full&sslcert=/path/to/cert.pem
+   ```
+2. Using dedicated SSL configuration section:
+   ```yaml
+   ssl:
+     mode: verify-full  # SSL verification mode
+     cert: /path/to/cert.pem      # Client certificate
+     key: /path/to/key.pem        # Client private key
+     root: /path/to/root.crt      # CA certificate
+   ```
+
+PostgreSQL SSL Modes:
+- disable: No SSL
+- require: Use SSL but no certificate verification
+- verify-ca: Verify server certificate is signed by trusted CA
+- verify-full: Verify server certificate and hostname match
+
+MySQL SSL Configuration:
+1. Using URL parameters:
+   ```
+   mysql://host:port/dbname?ssl-mode=verify_identity&ssl-ca=/path/to/ca.pem
+   ```
+2. Using dedicated SSL configuration section:
+   ```yaml
+   ssl:
+     mode: verify_identity  # SSL verification mode
+     ca: /path/to/ca.pem         # CA certificate
+     cert: /path/to/cert.pem     # Client certificate
+     key: /path/to/key.pem       # Client private key
+   ```
+
+MySQL SSL Modes:
+- disabled: No SSL
+- preferred: Use SSL if available, but allow unencrypted connection
+- required: Always use SSL, but don't verify server certificate
+- verify_ca: Verify server certificate is signed by trusted CA
+- verify_identity: Verify server certificate and hostname match
+
+SQLite Configuration Options:
+1. Basic configuration with path:
+   ```yaml
+   type: sqlite
+   path: /path/to/db.sqlite
+   password: optional_password  # Optional encryption
+   ```
+2. Using URI parameters:
+   ```yaml
+   type: sqlite
+   path: /path/to/db.sqlite?mode=ro&cache=shared
+   ```
 
 ### Debug Mode
 Set environment variable `MCP_DEBUG=1` to enable debug mode for detailed logging output.
@@ -185,12 +270,15 @@ graph TD
     DatabaseHandler[Database Handler]
     PostgresHandler[PostgreSQL Handler]
     SQLiteHandler[SQLite Handler]
+    MySQLHandler[MySQL Handler]
     DatabaseServer --> DatabaseHandler
     DatabaseHandler --> PostgresHandler
     DatabaseHandler --> SQLiteHandler
+    DatabaseHandler --> MySQLHandler
   end
   PostgresHandler --> PostgreSQL[(PostgreSQL)]
   SQLiteHandler --> SQLite[(SQLite)]
+  MySQLHandler --> MySQL[(MySQL)]
 ```
 
 The abstraction layer design is the core architectural concept in MCP Database Utilities. Just like a universal remote control that works with different devices, users only need to know the basic operations without understanding the underlying complexities.
@@ -202,7 +290,7 @@ The abstraction layer design is the core architectural concept in MCP Database U
 
 #### 2. Unified Interface Design
 - DatabaseHandler abstract class defines unified operation interfaces
-- All specific database implementations (PostgreSQL/SQLite) follow the same interface
+- All specific database implementations (PostgreSQL/SQLite/MySQL) follow the same interface
 - Users interact with different databases in the same way
 
 #### 3. Configuration and Implementation Separation
@@ -219,7 +307,7 @@ The abstraction layer design is the core architectural concept in MCP Database U
 2. DatabaseHandler
    - Abstract base class defining unified interface
    - Includes get_tables(), get_schema(), execute_query(), etc.
-   - Implemented by PostgreSQL and SQLite handlers
+   - Implemented by PostgreSQL, SQLite, and MySQL handlers
 
 3. Configuration System
    - YAML-based configuration file
@@ -342,6 +430,13 @@ Provides SQLite-specific features:
 - URI scheme support
 - Password protection support (optional)
 
+### MySQL Implementation
+Provides MySQL-specific features:
+- Remote connection support
+- Character set configuration
+- SSL/TLS secure connection
+- URL and standard connection methods
+
 ## Contributing
 Contributions are welcome! Here's how you can help:
 
@@ -361,7 +456,6 @@ For detailed guidelines, see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
 - [MCP Servers](https://github.com/modelcontextprotocol/servers) for inspiration and demonstration
 - AI Editors:
   * [Claude Desktop](https://claude.ai/download)
-  * [5ire](https://5ire.app/)
   * [Cline](https://cline.bot)
 - [Model Context Protocol](https://modelcontextprotocol.io/) for comprehensive interfaces