@yanzhang123/readonly-db-mcp 0.7.2 → 0.7.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Dana K. Williams
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2024 Dana K. Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,15 +1,15 @@
 [![Tests](https://github.com/12zhangyan/mysql_mcp_server/actions/workflows/test.yml/badge.svg)](https://github.com/12zhangyan/mysql_mcp_server/actions)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/mysql-mcp-server)](https://pypi.org/project/mysql-mcp-server/)
-[![AgentAudit Safe](https://img.shields.io/badge/AgentAudit-safe-brightgreen)](https://www.agentaudit.dev/packages/mysql-mcp-server)
-# MySQL MCP Server
-A Model Context Protocol (MCP) implementation that enables secure interaction with MySQL databases. This server component facilitates communication between AI applications (hosts/clients) and MySQL databases, making database exploration and analysis safer and more structured through a controlled interface.
-
-> **Note**: MySQL MCP Server supports both standard input/output (STDIO) and Streamable HTTP (SSE) transport modes. The SSE mode is recommended for remote/self-hosted deployments.
-
-## Deployment options
-- **Hosted** — [Fronteir AI](https://fronteir.ai/mcp/designcomputer-mysql-mcp-server) runs the server for you; no local setup required.
-- **Local** — [Smithery](https://smithery.ai/server/designcomputer/mysql-mcp-server) installs and runs the server on your own machine.
-
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/mysql-mcp-server)](https://pypi.org/project/mysql-mcp-server/)
+[![AgentAudit Safe](https://img.shields.io/badge/AgentAudit-safe-brightgreen)](https://www.agentaudit.dev/packages/mysql-mcp-server)
+# MySQL MCP Server
+A Model Context Protocol (MCP) implementation that enables secure interaction with MySQL databases. This server component facilitates communication between AI applications (hosts/clients) and MySQL databases, making database exploration and analysis safer and more structured through a controlled interface.
+
+> **Note**: MySQL MCP Server supports both standard input/output (STDIO) and Streamable HTTP (SSE) transport modes. The SSE mode is recommended for remote/self-hosted deployments.
+
+## Deployment options
+- **Hosted** — [Fronteir AI](https://fronteir.ai/mcp/designcomputer-mysql-mcp-server) runs the server for you; no local setup required.
+- **Local** — [Smithery](https://smithery.ai/server/designcomputer/mysql-mcp-server) installs and runs the server on your own machine.
+
 ## Features
 - **Named connection profiles** for dev/test/staging/prod and multiple servers
 - Select a `connection` and `database` independently on every tool call
@@ -20,7 +20,7 @@ A Model Context Protocol (MCP) implementation that enables secure interaction wi
 - **SSE/HTTP transport support** (`MCP_TRANSPORT=sse`)
 - Per-profile SSL/TLS and SSH tunneling
 - Passwords can stay in environment variables instead of the profiles file
-
+
 ## Installation
 
 ### npm / npx
@@ -43,21 +43,21 @@ For MCP clients, use `npx` as the command and
 `["-y", "@yanzhang123/readonly-db-mcp"]` as its arguments.
 
 ### Manual Installation
-```bash
-pip install mysql-mcp-server
-```
-
-### Installing via Smithery
-To install MySQL MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/designcomputer/mysql-mcp-server):
-```bash
-npx -y @smithery/cli install designcomputer/mysql-mcp-server --client claude
-```
-
-### Installing via Claude Code CLI
-```bash
-claude mcp add --transport stdio designcomputer-mysql_mcp_server uvx mysql_mcp_server
-```
-
+```bash
+pip install mysql-mcp-server
+```
+
+### Installing via Smithery
+To install MySQL MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/designcomputer/mysql-mcp-server):
+```bash
+npx -y @smithery/cli install designcomputer/mysql-mcp-server --client claude
+```
+
+### Installing via Claude Code CLI
+```bash
+claude mcp add --transport stdio designcomputer-mysql_mcp_server uvx mysql_mcp_server
+```
+
 ## Configuration
 
 ### Recommended: named connections
@@ -163,8 +163,8 @@ MYSQL_PORT=3306         # Optional: Database port (defaults to 3306 if not speci
 MYSQL_USER=readonly_user
 MYSQL_PASSWORD=your_password
 MYSQL_DATABASE=your_database # Optional: Omit for multi-database mode
-
-# Advanced Configuration
+
+# Advanced Configuration
 MYSQL_SSL_MODE=REQUIRED  # DISABLED, REQUIRED, VERIFY_CA, VERIFY_IDENTITY
 MYSQL_SSL_CA=            # required for VERIFY_CA / VERIFY_IDENTITY
 MYSQL_CONNECT_TIMEOUT=10 # Timeout in seconds
@@ -183,18 +183,18 @@ MYSQL_AUDIT_REQUIRED_CONTEXT=actor,purpose,ticket_id
 MYSQL_AUDIT_FAIL_CLOSED=true
 MYSQL_AUDIT_FSYNC=true
 MYSQL_ALLOWED_DATABASES=your_database
-
-# Connection behaviour (Optional)
-MYSQL_SQL_MODE=TRADITIONAL           # SQL mode applied to the connection (default: TRADITIONAL)
-
-# Compatibility (Optional)
-MYSQL_CHARSET=utf8mb4
-MYSQL_COLLATION=utf8mb4_unicode_ci
-MYSQL_AUTH_PLUGIN=       # e.g., mysql_native_password for older MySQL versions
-MYSQL_USE_PURE=false     # Force the pure-Python connector (default: false)
-MYSQL_RAISE_ON_WARNINGS=false        # Raise on SQL warnings (default: false)
-
-# SSE Transport (Optional)
+
+# Connection behaviour (Optional)
+MYSQL_SQL_MODE=TRADITIONAL           # SQL mode applied to the connection (default: TRADITIONAL)
+
+# Compatibility (Optional)
+MYSQL_CHARSET=utf8mb4
+MYSQL_COLLATION=utf8mb4_unicode_ci
+MYSQL_AUTH_PLUGIN=       # e.g., mysql_native_password for older MySQL versions
+MYSQL_USE_PURE=false     # Force the pure-Python connector (default: false)
+MYSQL_RAISE_ON_WARNINGS=false        # Raise on SQL warnings (default: false)
+
+# SSE Transport (Optional)
 MCP_TRANSPORT=stdio      # stdio or sse
 MCP_SSE_HOST=127.0.0.1   # Safe default: loopback only
 PORT=8000                # HTTP port (fallback for MCP_SSE_PORT)
@@ -202,30 +202,30 @@ MCP_SSE_ALLOWED_HOSTS=   # Comma-separated allowed Host headers (default: localh
 MCP_SSE_BEARER_TOKEN=    # Optional; at least 32 characters
 # Set only when an authenticated reverse proxy is the sole network entry point:
 MCP_SSE_TRUST_PROXY_AUTH=false
-
-# SSH Tunneling (Optional)
-MYSQL_SSH_ENABLE=false   # Set to true to enable
-MYSQL_SSH_HOST=          # SSH jump host
-MYSQL_SSH_PORT=22        # SSH port
-MYSQL_SSH_USER=          # SSH username
-MYSQL_SSH_KEY_PATH=      # Path to SSH private key
-MYSQL_SSH_REMOTE_HOST=localhost # Host from the perspective of the jump host
-MYSQL_SSH_REMOTE_PORT=3306
+
+# SSH Tunneling (Optional)
+MYSQL_SSH_ENABLE=false   # Set to true to enable
+MYSQL_SSH_HOST=          # SSH jump host
+MYSQL_SSH_PORT=22        # SSH port
+MYSQL_SSH_USER=          # SSH username
+MYSQL_SSH_KEY_PATH=      # Path to SSH private key
+MYSQL_SSH_REMOTE_HOST=localhost # Host from the perspective of the jump host
+MYSQL_SSH_REMOTE_PORT=3306
 MYSQL_LOCAL_PORT=0       # 0 selects a free port; the tunnel is reused
 ```
-
-### `.env` file loading
-
-On startup the server automatically loads a `.env` file via `python-dotenv`, so for local use you can simply:
-
-```bash
-cp .env.example .env   # then edit with your credentials
-```
-
-The file is read from the **process working directory** (and parent directories), which works when you run the server yourself from the project folder.
-
-> ⚠️ **Claude Code / Claude Desktop:** these hosts launch the server from their own working directory, so the project's `.env` will **not** be found and you'll see `Missing required database configuration`. Put your `MYSQL_*` values in the `env` block of the MCP config (shown in the Usage section below) rather than relying on `.env`.
-
+
+### `.env` file loading
+
+On startup the server automatically loads a `.env` file via `python-dotenv`, so for local use you can simply:
+
+```bash
+cp .env.example .env   # then edit with your credentials
+```
+
+The file is read from the **process working directory** (and parent directories), which works when you run the server yourself from the project folder.
+
+> ⚠️ **Claude Code / Claude Desktop:** these hosts launch the server from their own working directory, so the project's `.env` will **not** be found and you'll see `Missing required database configuration`. Put your `MYSQL_*` values in the `env` block of the MCP config (shown in the Usage section below) rather than relying on `.env`.
+
 ### Multi-database mode
 
 When `MYSQL_DATABASE` is not set, the server operates in multi-database mode:
@@ -275,114 +275,114 @@ Executes exactly one read-only statement.
 ### `get_schema_info`
 Provides detailed metadata about database structures.
 - **Arguments:** `table_name`, `connection`, `database` (all optional)
-- **Output:** Column names, types, nullability, default values, and comments.
-- **Cross-database:** Pass `database.table` to query a table outside `MYSQL_DATABASE`; bare names use the configured database.
-- **Identifier rules:** Names must contain only alphanumeric characters, underscores, and `$` (dots are allowed as a separator between database and table names).
-
+- **Output:** Column names, types, nullability, default values, and comments.
+- **Cross-database:** Pass `database.table` to query a table outside `MYSQL_DATABASE`; bare names use the configured database.
+- **Identifier rules:** Names must contain only alphanumeric characters, underscores, and `$` (dots are allowed as a separator between database and table names).
+
 ### `get_table_sample`
 Fetches a representative sample of data.
 - **Arguments:** `table_name` (required), `limit` (optional integer, max 100), `offset`, `connection`, `database`, `timeout_ms`, `result_format`
-- **Use Case:** Quickly understand data formats and content without fetching large result sets.
-- **Cross-database:** Pass `database.table` to sample a table outside `MYSQL_DATABASE`; bare names use the configured database.
-- **Identifier rules:** Names must contain only alphanumeric characters, underscores, and `$` (dots are allowed as a separator between database and table names).
-
-## Available Prompts
-
-In addition to tools, the server exposes **MCP prompts** — guided, multi-step workflows that a client can launch on demand. In Claude Code they appear as slash commands (`/mcp__<server>__<prompt>`); in Claude Desktop they appear in the prompts (`+`) menu.
-
-| Prompt | Arguments | Description |
-| --- | --- | --- |
+- **Use Case:** Quickly understand data formats and content without fetching large result sets.
+- **Cross-database:** Pass `database.table` to sample a table outside `MYSQL_DATABASE`; bare names use the configured database.
+- **Identifier rules:** Names must contain only alphanumeric characters, underscores, and `$` (dots are allowed as a separator between database and table names).
+
+## Available Prompts
+
+In addition to tools, the server exposes **MCP prompts** — guided, multi-step workflows that a client can launch on demand. In Claude Code they appear as slash commands (`/mcp__<server>__<prompt>`); in Claude Desktop they appear in the prompts (`+`) menu.
+
+| Prompt | Arguments | Description |
+| --- | --- | --- |
 | `explore_database` | `connection`, `database` *(optional)* | Systematically explore the selected database: discover tables, inspect schemas, sample data, and summarize it. |
 | `analyze_table` | `table_name` *(required)*; `connection`, `database` *(optional)* | Deep-dive into a specific table. Accepts `database.table` notation. |
-
-**Example (Claude Code):**
-```
-/mcp__mysql__explore_database
-/mcp__mysql__analyze_table customers
-```
-
+
+**Example (Claude Code):**
+```
+/mcp__mysql__explore_database
+/mcp__mysql__analyze_table customers
+```
+
 Both prompts orchestrate the read-only discovery, schema, and sampling tools.
-
-## Usage
-### With Claude Desktop
-Add this to your `claude_desktop_config.json`:
-```json
-{
-  "mcpServers": {
-    "mysql": {
-      "command": "uv",
-      "args": [
-        "--directory",
-        "path/to/mysql_mcp_server",
-        "run",
-        "mysql_mcp_server"
+
+## Usage
+### With Claude Desktop
+Add this to your `claude_desktop_config.json`:
+```json
+{
+  "mcpServers": {
+    "mysql": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "path/to/mysql_mcp_server",
+        "run",
+        "mysql_mcp_server"
       ],
       "env": {
         "MYSQL_PROFILES_FILE": "C:/absolute/path/mysql-connections.toml",
         "MYSQL_DEV_PASSWORD": "your_dev_password",
         "MYSQL_PROD_PASSWORD": "your_prod_password"
       }
-    }
-  }
-}
-```
-
-For more detailed examples and agent-specific guidance, see [MCP_USECASES.md](MCP_USECASES.md).
-
-### With Visual Studio Code
-Add this to your `mcp.json`:
-```json
-{
-  "mcpServers": {
-    "mysql": {
-      "type": "stdio",
-      "command": "uvx",
-      "args": [
-        "--from",
-        "mysql-mcp-server",
-        "mysql_mcp_server"
+    }
+  }
+}
+```
+
+For more detailed examples and agent-specific guidance, see [MCP_USECASES.md](MCP_USECASES.md).
+
+### With Visual Studio Code
+Add this to your `mcp.json`:
+```json
+{
+  "mcpServers": {
+    "mysql": {
+      "type": "stdio",
+      "command": "uvx",
+      "args": [
+        "--from",
+        "mysql-mcp-server",
+        "mysql_mcp_server"
       ],
       "env": {
         "MYSQL_PROFILES_FILE": "C:/absolute/path/mysql-connections.toml",
         "MYSQL_DEV_PASSWORD": "your_dev_password",
         "MYSQL_PROD_PASSWORD": "your_prod_password"
       }
-    }
-  }
-}
-```
-Note: Will need to install uv for this to work
-
-### Debugging with MCP Inspector
-While MySQL MCP Server isn't intended to be run standalone or directly from the command line with Python, you can use the MCP Inspector to debug it.
-
-The MCP Inspector provides a convenient way to test and debug your MCP implementation:
-
-```bash
-# Install dependencies
-pip install -r requirements.txt
-# Use the MCP Inspector for debugging (do not run directly with Python)
-```
-
-The MySQL MCP Server is designed to be integrated with AI applications like Claude Desktop and should not be run directly as a standalone Python program.
-
-## Development
-```bash
-# Clone the repository
+    }
+  }
+}
+```
+Note: Will need to install uv for this to work
+
+### Debugging with MCP Inspector
+While MySQL MCP Server isn't intended to be run standalone or directly from the command line with Python, you can use the MCP Inspector to debug it.
+
+The MCP Inspector provides a convenient way to test and debug your MCP implementation:
+
+```bash
+# Install dependencies
+pip install -r requirements.txt
+# Use the MCP Inspector for debugging (do not run directly with Python)
+```
+
+The MySQL MCP Server is designed to be integrated with AI applications like Claude Desktop and should not be run directly as a standalone Python program.
+
+## Development
+```bash
+# Clone the repository
 git clone https://github.com/12zhangyan/mysql_mcp_server.git
-cd mysql_mcp_server
-# Create virtual environment
-python -m venv venv
-source venv/bin/activate  # or `venv\Scripts\activate` on Windows
-# Install development dependencies
-pip install -r requirements-dev.txt
-# Copy the example config and edit with your credentials
-cp .env.example .env
-# Edit .env with your MySQL connection details
-# Run tests
-pytest
-```
-
+cd mysql_mcp_server
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # or `venv\Scripts\activate` on Windows
+# Install development dependencies
+pip install -r requirements-dev.txt
+# Copy the example config and edit with your credentials
+cp .env.example .env
+# Edit .env with your MySQL connection details
+# Run tests
+pytest
+```
+
 ## Security Considerations
 - **Read-only SQL gate:** Only result-producing read statements are accepted; write/DDL/transaction/locking constructs are rejected before a connection is opened.
 - **Database enforcement:** Every exposed query runs with `autocommit=false` in a read-only transaction. Normal completion rolls back; cancellation or truncation closes the socket and forces server-side rollback.
@@ -401,50 +401,50 @@ pytest
 - **Diagnostic Privacy:** Connection diagnostics expose an account fingerprint and privilege summary, not raw usernames or `SHOW GRANTS`; configuration paths and database-supplied error text are redacted.
 - **Least Privilege:** A dedicated `SELECT` account is recommended as additional defense, but it is not assumed by the MCP read-only enforcement. `check_connection` warns about broader grants without disabling the profile.
 - **SSE is loopback-only by default.** Configure `MCP_SSE_BEARER_TOKEN` with at least 32 characters to enable built-in bearer authentication. A non-loopback bind is refused unless bearer authentication is enabled or `MCP_SSE_TRUST_PROXY_AUTH=true` explicitly confirms that an authenticated reverse proxy is the only network entry point. Example with nginx and HTTP Basic Auth:
-
-  ```nginx
-  location /sse {
-      auth_basic "MCP";
-      auth_basic_user_file /etc/nginx/.htpasswd;
-      proxy_pass http://127.0.0.1:8000;
-      proxy_set_header Host $host;
-      proxy_buffering off;
-  }
-  location /messages/ {
-      auth_basic "MCP";
-      auth_basic_user_file /etc/nginx/.htpasswd;
-      proxy_pass http://127.0.0.1:8000;
-      proxy_set_header Host $host;
-  }
-  ```
-
+
+  ```nginx
+  location /sse {
+      auth_basic "MCP";
+      auth_basic_user_file /etc/nginx/.htpasswd;
+      proxy_pass http://127.0.0.1:8000;
+      proxy_set_header Host $host;
+      proxy_buffering off;
+  }
+  location /messages/ {
+      auth_basic "MCP";
+      auth_basic_user_file /etc/nginx/.htpasswd;
+      proxy_pass http://127.0.0.1:8000;
+      proxy_set_header Host $host;
+  }
+  ```
+
   Keep `MCP_SSE_HOST=127.0.0.1` so the proxy is the sole public entry point. If a container requires `0.0.0.0`, set `MCP_SSE_TRUST_PROXY_AUTH=true` only after network policy prevents direct access. Set `MCP_SSE_ALLOWED_HOSTS` to the hostname forwarded by the proxy.
 
 See [SECURITY.md](SECURITY.md) and [ENTERPRISE_DEPLOYMENT.md](ENTERPRISE_DEPLOYMENT.md) for deployment and audit guidance.
 Maintainers should follow [RELEASING.md](RELEASING.md) for synchronized Python/npm version releases.
-
-## Security Best Practices
-This MCP implementation requires database access to function. For security:
+
+## Security Best Practices
+This MCP implementation requires database access to function. For security:
 1. **Create a dedicated MySQL user** with `SELECT` only
-2. **Never use root credentials** or administrative accounts
-3. **Restrict database access** to only necessary operations
-4. **Enable logging** for audit purposes
-5. **Regular security reviews** of database access
-
+2. **Never use root credentials** or administrative accounts
+3. **Restrict database access** to only necessary operations
+4. **Enable logging** for audit purposes
+5. **Regular security reviews** of database access
+
 See [MySQL Security Configuration Guide](https://github.com/12zhangyan/mysql_mcp_server/blob/main/SECURITY.md) for detailed instructions on:
-- Creating a restricted MySQL user
-- Setting appropriate permissions
-- Monitoring database access
-- Security best practices
-
-⚠️ IMPORTANT: Always follow the principle of least privilege when configuring database access.
-
-## License
-MIT License - see LICENSE file for details.
-
-## Contributing
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
+- Creating a restricted MySQL user
+- Setting appropriate permissions
+- Monitoring database access
+- Security best practices
+
+⚠️ IMPORTANT: Always follow the principle of least privilege when configuring database access.
+
+## License
+MIT License - see LICENSE file for details.
+
+## Contributing
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request

package/SECURITY.md

@@ -1,137 +1,137 @@
-## MySQL Security Configuration
-
-### Creating a Restricted MySQL User
-
-It's crucial to create a dedicated MySQL user with minimal permissions for the MCP server. Never use the root account or a user with full administrative privileges.
-
-#### 1. Create a new MySQL user
-
-```sql
--- Connect as root or administrator
-CREATE USER 'mcp_user'@'localhost' IDENTIFIED BY 'your_secure_password';
-```
-
-#### 2. Grant minimal required permissions
-
-Basic read-only access (recommended for exploration and analysis):
-```sql
--- Grant SELECT permission only
-GRANT SELECT ON your_database.* TO 'mcp_user'@'localhost';
-```
-
+## MySQL Security Configuration
+
+### Creating a Restricted MySQL User
+
+It's crucial to create a dedicated MySQL user with minimal permissions for the MCP server. Never use the root account or a user with full administrative privileges.
+
+#### 1. Create a new MySQL user
+
+```sql
+-- Connect as root or administrator
+CREATE USER 'mcp_user'@'localhost' IDENTIFIED BY 'your_secure_password';
+```
+
+#### 2. Grant minimal required permissions
+
+Basic read-only access (recommended for exploration and analysis):
+```sql
+-- Grant SELECT permission only
+GRANT SELECT ON your_database.* TO 'mcp_user'@'localhost';
+```
+
 Do not grant `INSERT`, `UPDATE`, `DELETE`, DDL, routine execution, file, lock, or
 temporary-table privileges to the MCP account. The server rejects those operations,
 and MySQL permissions provide the final security boundary.
-
-#### 3. Apply the permissions
-```sql
-FLUSH PRIVILEGES;
-```
-
-### Additional Security Measures
-
-1. **Network Access**
-   - Restrict the user to connecting only from localhost if the MCP server runs on the same machine
-   - If remote access is needed, specify exact IP addresses rather than using wildcards
-
-2. **Query Restrictions**
-   - Consider using VIEWs to further restrict data access
+
+#### 3. Apply the permissions
+```sql
+FLUSH PRIVILEGES;
+```
+
+### Additional Security Measures
+
+1. **Network Access**
+   - Restrict the user to connecting only from localhost if the MCP server runs on the same machine
+   - If remote access is needed, specify exact IP addresses rather than using wildcards
+
+2. **Query Restrictions**
+   - Consider using VIEWs to further restrict data access
    - Set an appropriate `max_queries_per_hour` limit:
-   ```sql
-   ALTER USER 'mcp_user'@'localhost' 
+   ```sql
+   ALTER USER 'mcp_user'@'localhost' 
    WITH MAX_QUERIES_PER_HOUR 1000;
-   ```
-
-3. **Data Access Control**
-   - Grant access only to specific tables when possible
-   - Use column-level permissions for sensitive data:
-   ```sql
-   GRANT SELECT (public_column1, public_column2) 
-   ON your_database.sensitive_table TO 'mcp_user'@'localhost';
-   ```
-
-4. **Regular Auditing**
-   - Enable MySQL audit logging for the MCP user
-   - Regularly review logs for unusual patterns
-   - Periodically review and adjust permissions
-
-### Environment Configuration
-
-When setting up the MCP server, use these restricted credentials in your environment:
-
-```bash
-MYSQL_USER=mcp_user
-MYSQL_PASSWORD=your_secure_password
-MYSQL_DATABASE=your_database
-MYSQL_HOST=localhost
-```
-
-### Monitoring Usage
-
-To monitor the MCP user's database usage:
-
-```sql
--- Check current connections
-SELECT * FROM information_schema.PROCESSLIST 
-WHERE user = 'mcp_user';
-
--- View user privileges
-SHOW GRANTS FOR 'mcp_user'@'localhost';
-
--- Check resource limits
-SELECT * FROM mysql.user 
-WHERE user = 'mcp_user' AND host = 'localhost';
-```
-
-### Best Practices
-
-1. **Regular Password Rotation**
-   - Change the MCP user's password periodically
-   - Use strong, randomly generated passwords
-   - Update application configurations after password changes
-
-2. **Permission Review**
-   - Regularly audit granted permissions
-   - Remove unnecessary privileges
-   - Keep permissions as restrictive as possible
-
-3. **Access Patterns**
-   - Monitor query patterns for potential issues
-   - Set up alerts for unusual activity
-   - Maintain detailed logs of database access
-
-4. **Data Protection**
-   - Consider encrypting sensitive columns
-   - Use SSL/TLS for database connections (see **SSL/TLS Support** below)
-   - Implement data masking where appropriate
-
-### Secure Remote Access (SSH Tunneling)
-
-If your MySQL server is not on the same network as the MCP server, **do not expose MySQL directly to the internet.** Instead, use the built-in SSH tunneling support:
-
-1. Enable SSH tunneling by setting `MYSQL_SSH_ENABLE=true`.
-2. Configure your SSH jump host credentials and private key path.
-3. The MCP server will establish a secure encrypted tunnel and connect to MySQL over `localhost`, keeping your database port closed to the outside world.
-
-### SSL/TLS Support
-
-For production environments, always encrypt the connection between the MCP server and MySQL.
-
+   ```
+
+3. **Data Access Control**
+   - Grant access only to specific tables when possible
+   - Use column-level permissions for sensitive data:
+   ```sql
+   GRANT SELECT (public_column1, public_column2) 
+   ON your_database.sensitive_table TO 'mcp_user'@'localhost';
+   ```
+
+4. **Regular Auditing**
+   - Enable MySQL audit logging for the MCP user
+   - Regularly review logs for unusual patterns
+   - Periodically review and adjust permissions
+
+### Environment Configuration
+
+When setting up the MCP server, use these restricted credentials in your environment:
+
+```bash
+MYSQL_USER=mcp_user
+MYSQL_PASSWORD=your_secure_password
+MYSQL_DATABASE=your_database
+MYSQL_HOST=localhost
+```
+
+### Monitoring Usage
+
+To monitor the MCP user's database usage:
+
+```sql
+-- Check current connections
+SELECT * FROM information_schema.PROCESSLIST 
+WHERE user = 'mcp_user';
+
+-- View user privileges
+SHOW GRANTS FOR 'mcp_user'@'localhost';
+
+-- Check resource limits
+SELECT * FROM mysql.user 
+WHERE user = 'mcp_user' AND host = 'localhost';
+```
+
+### Best Practices
+
+1. **Regular Password Rotation**
+   - Change the MCP user's password periodically
+   - Use strong, randomly generated passwords
+   - Update application configurations after password changes
+
+2. **Permission Review**
+   - Regularly audit granted permissions
+   - Remove unnecessary privileges
+   - Keep permissions as restrictive as possible
+
+3. **Access Patterns**
+   - Monitor query patterns for potential issues
+   - Set up alerts for unusual activity
+   - Maintain detailed logs of database access
+
+4. **Data Protection**
+   - Consider encrypting sensitive columns
+   - Use SSL/TLS for database connections (see **SSL/TLS Support** below)
+   - Implement data masking where appropriate
+
+### Secure Remote Access (SSH Tunneling)
+
+If your MySQL server is not on the same network as the MCP server, **do not expose MySQL directly to the internet.** Instead, use the built-in SSH tunneling support:
+
+1. Enable SSH tunneling by setting `MYSQL_SSH_ENABLE=true`.
+2. Configure your SSH jump host credentials and private key path.
+3. The MCP server will establish a secure encrypted tunnel and connect to MySQL over `localhost`, keeping your database port closed to the outside world.
+
+### SSL/TLS Support
+
+For production environments, always encrypt the connection between the MCP server and MySQL.
+
 Use the `MYSQL_SSL_MODE` environment variable to control encryption:
 - `DISABLED`: Allows plaintext only when explicitly selected; do not use in production.
 - `REQUIRED`: Ensures the connection is encrypted.
-- `VERIFY_CA`: Encrypts and verifies the server's certificate against a CA.
-- `VERIFY_IDENTITY`: Encrypts and verifies that the server's hostname matches the certificate.
-
+- `VERIFY_CA`: Encrypts and verifies the server's certificate against a CA.
+- `VERIFY_IDENTITY`: Encrypts and verifies that the server's hostname matches the certificate.
+
 `REQUIRED` is the default, and the MCP verifies after connection that the
 connector reports an encrypted session. Specify the CA certificate path using
 `MYSQL_SSL_CA` when using either verification mode.
-
+
 ### SQL Injection Protection
-
-The MCP server includes built-in protection against SQL injection for administrative operations:
-- All database and table identifiers provided via resources or tool arguments are strictly validated against a regex whitelist (`^[a-zA-Z0-9_$]+$`).
-- Identifiers are automatically quoted with backticks in internal queries.
+
+The MCP server includes built-in protection against SQL injection for administrative operations:
+- All database and table identifiers provided via resources or tool arguments are strictly validated against a regex whitelist (`^[a-zA-Z0-9_$]+$`).
+- Identifiers are automatically quoted with backticks in internal queries.
 - `execute_sql` uses a lexer-style guard that ignores ordinary strings and comments but rejects MySQL `/*!...*/` and MariaDB `/*M!...*/` executable comments, multiple statements, DML, DDL, locks, transactions, `SELECT INTO`, and session assignment.
 - Stored functions and UDFs are fail-closed unless sqlglot recognizes them as a
   built-in or their reviewed name is explicitly listed in `allowed_functions`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yanzhang123/readonly-db-mcp",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "Enterprise-auditable, strictly read-only MySQL MCP server with multi-environment profiles.",
   "license": "MIT",
   "type": "commonjs",