@berthojoris/mcp-mysql-server 1.4.13 → 1.4.15
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.
- package/CHANGELOG.md +25 -0
- package/DOCUMENTATIONS.md +12 -12
- package/README.md +42 -41
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,31 @@ All notable changes to the MySQL MCP Server will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.4.15] - 2025-11-22
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
- **README.md Unicode encoding** - Fixed broken Unicode characters in Features section
|
|
12
|
+
- Corrected emoji encodings: 🌟 (star), ✅ (checkmark), 🔐 (lock), 🛠️ (tools), 🎛️ (control knobs), 🗃️ (file cabinet), 💎 (gem), 🌐 (globe), 📊 (chart)
|
|
13
|
+
- Removed BOM (Byte Order Mark) from file
|
|
14
|
+
- All emojis now display correctly across all platforms
|
|
15
|
+
- Fixed table formatting in Bulk Operations section
|
|
16
|
+
|
|
17
|
+
### Documentation
|
|
18
|
+
- Enhanced visual consistency in Features section
|
|
19
|
+
- Improved readability with proper emoji rendering
|
|
20
|
+
|
|
21
|
+
## [1.4.14] - 2025-11-22
|
|
22
|
+
|
|
23
|
+
### Fixed
|
|
24
|
+
- **Emoji encoding issues** - Fixed emoji rendering issues in README.md and DOCUMENTATIONS.md
|
|
25
|
+
- Replaced escaped Unicode sequences with proper emoji characters
|
|
26
|
+
- Fixed broken emoji displays throughout documentation
|
|
27
|
+
- Improved visual consistency across all documentation sections
|
|
28
|
+
|
|
29
|
+
### Documentation
|
|
30
|
+
- All emojis in section headers and feature lists now display correctly
|
|
31
|
+
- Enhanced readability with proper emoji rendering
|
|
32
|
+
|
|
8
33
|
## [1.4.13] - 2025-11-22
|
|
9
34
|
|
|
10
35
|
### Changed
|
package/DOCUMENTATIONS.md
CHANGED
|
@@ -6,17 +6,17 @@ This file contains detailed documentation for all features of the MySQL MCP Serv
|
|
|
6
6
|
|
|
7
7
|
## Table of Contents
|
|
8
8
|
|
|
9
|
-
1. [DDL Operations](
|
|
10
|
-
2. [Data Export Tools](
|
|
11
|
-
3. [Transaction Management](
|
|
12
|
-
4. [Stored Procedures](
|
|
13
|
-
5. [Usage Examples](
|
|
14
|
-
6. [Query Logging & Automatic SQL Display](
|
|
15
|
-
7. [Security Features](
|
|
16
|
-
8. [Bulk Operations](
|
|
17
|
-
9. [Troubleshooting](
|
|
18
|
-
10. [License](
|
|
19
|
-
11. [Roadmap](
|
|
9
|
+
1. [DDL Operations](#🏗️-ddl-operations)
|
|
10
|
+
2. [Data Export Tools](#📤-data-export-tools)
|
|
11
|
+
3. [Transaction Management](#💰-transaction-management)
|
|
12
|
+
4. [Stored Procedures](#🔧-stored-procedures)
|
|
13
|
+
5. [Usage Examples](#📋-usage-examples)
|
|
14
|
+
6. [Query Logging & Automatic SQL Display](#📝-query-logging--automatic-sql-display)
|
|
15
|
+
7. [Security Features](#🔒-security-features)
|
|
16
|
+
8. [Bulk Operations](#🚀-bulk-operations)
|
|
17
|
+
9. [Troubleshooting](#🛠️-troubleshooting)
|
|
18
|
+
10. [License](#📄-license)
|
|
19
|
+
11. [Roadmap](#🗺️-roadmap)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
@@ -1101,7 +1101,7 @@ Each bulk operation returns performance metrics:
|
|
|
1101
1101
|
|
|
1102
1102
|
---
|
|
1103
1103
|
|
|
1104
|
-
##
|
|
1104
|
+
## 🛠️ Troubleshooting
|
|
1105
1105
|
|
|
1106
1106
|
### MCP Server Not Connecting
|
|
1107
1107
|
|
package/README.md
CHANGED
|
@@ -7,21 +7,21 @@ A fully-featured **Model Context Protocol (MCP)** server for MySQL database inte
|
|
|
7
7
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
##
|
|
11
|
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
10
|
+
## 🌟 Features
|
|
11
|
+
|
|
12
|
+
- ✅ **Full MCP Protocol Support** - Works with Claude Desktop, Cline, Windsurf, and any MCP-compatible AI agent
|
|
13
|
+
- 🔐 **Secure by Default** - Parameterized queries, SQL injection protection, permission-based access control
|
|
14
|
+
- 🛠️ **30 Powerful Tools** - Complete database operations (CRUD, DDL, queries, schema inspection, transactions, stored procedures, bulk operations)
|
|
15
|
+
- 🎛️ **Dynamic Per-Project Permissions** - Each AI agent can have different access levels
|
|
16
|
+
- 🗃️ **DDL Support** - Create, alter, and drop tables (when explicitly enabled)
|
|
17
|
+
- 💎 **Transaction Support** - Full ACID transaction management (BEGIN, COMMIT, ROLLBACK)
|
|
18
|
+
- 🌐 **Dual Mode** - Run as MCP server OR as REST API
|
|
19
|
+
- 📊 **Rich Metadata** - Table schemas, relationships, connection info
|
|
20
|
+
- ⚡ **TypeScript** - Fully typed with TypeScript definitions
|
|
21
21
|
|
|
22
22
|
---
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## 📦 Installation
|
|
25
25
|
|
|
26
26
|
### Option 1: Quick Start (npx)
|
|
27
27
|
|
|
@@ -40,7 +40,7 @@ mcp-mysql mysql://user:pass@localhost:3306/db "list,read,utility"
|
|
|
40
40
|
|
|
41
41
|
---
|
|
42
42
|
|
|
43
|
-
##
|
|
43
|
+
## 🚀 Quick Start
|
|
44
44
|
|
|
45
45
|
### 1. Set Up Environment
|
|
46
46
|
|
|
@@ -254,7 +254,7 @@ Control access with these permission categories:
|
|
|
254
254
|
{
|
|
255
255
|
"args": [
|
|
256
256
|
"mysql://user:pass@localhost:3306/db",
|
|
257
|
-
"list,read,utility" //
|
|
257
|
+
"list,read,utility" // ← Permissions here
|
|
258
258
|
]
|
|
259
259
|
}
|
|
260
260
|
```
|
|
@@ -347,7 +347,7 @@ You can have different databases with different permissions in the same AI agent
|
|
|
347
347
|
|
|
348
348
|
---
|
|
349
349
|
|
|
350
|
-
##
|
|
350
|
+
## 🚫 Permission Error Handling
|
|
351
351
|
|
|
352
352
|
The MySQL MCP Server provides clear, user-friendly error messages when operations are attempted without proper permissions. This helps users understand exactly what permissions are needed and how to enable them.
|
|
353
353
|
|
|
@@ -356,7 +356,7 @@ The MySQL MCP Server provides clear, user-friendly error messages when operation
|
|
|
356
356
|
When a tool is called without the required permission, you'll receive a detailed error message like:
|
|
357
357
|
|
|
358
358
|
```
|
|
359
|
-
|
|
359
|
+
❌ Permission denied: Cannot use tool 'create_table'. This tool requires 'ddl' permission.
|
|
360
360
|
|
|
361
361
|
Current permissions: list,read,utility
|
|
362
362
|
To enable this tool, add 'ddl' to your permissions configuration.
|
|
@@ -375,7 +375,7 @@ Tool description: Create new tables with columns and indexes
|
|
|
375
375
|
|
|
376
376
|
**Error response when DDL not enabled:**
|
|
377
377
|
```
|
|
378
|
-
|
|
378
|
+
❌ Permission denied: Cannot use tool 'create_table'. This tool requires 'ddl' permission.
|
|
379
379
|
|
|
380
380
|
Current permissions: list,read,utility
|
|
381
381
|
To enable this tool, add 'ddl' to your permissions configuration.
|
|
@@ -392,7 +392,7 @@ Tool description: Create new tables with columns and indexes
|
|
|
392
392
|
|
|
393
393
|
**Error response when CREATE not enabled:**
|
|
394
394
|
```
|
|
395
|
-
|
|
395
|
+
❌ Permission denied: Cannot use tool 'create_record'. This tool requires 'create' permission.
|
|
396
396
|
|
|
397
397
|
Current permissions: list,read,utility
|
|
398
398
|
To enable this tool, add 'create' to your permissions configuration.
|
|
@@ -409,7 +409,7 @@ Tool description: Insert new records with automatic SQL generation
|
|
|
409
409
|
|
|
410
410
|
**Error response when UPDATE not enabled:**
|
|
411
411
|
```
|
|
412
|
-
|
|
412
|
+
❌ Permission denied: Cannot use tool 'update_record'. This tool requires 'update' permission.
|
|
413
413
|
|
|
414
414
|
Current permissions: list,read,utility
|
|
415
415
|
To enable this tool, add 'update' to your permissions configuration.
|
|
@@ -422,11 +422,11 @@ Tool description: Update existing records based on conditions
|
|
|
422
422
|
|
|
423
423
|
### Permission Error Benefits
|
|
424
424
|
|
|
425
|
-
1.
|
|
426
|
-
2.
|
|
427
|
-
3.
|
|
428
|
-
4.
|
|
429
|
-
5.
|
|
425
|
+
1. **🎯 Clear Guidance** - Exact permission needed and how to add it
|
|
426
|
+
2. **📋 Current State** - Shows what permissions are currently active
|
|
427
|
+
3. **💡 Example Configuration** - Ready-to-use configuration example
|
|
428
|
+
4. **📖 Tool Context** - Explains what the tool does
|
|
429
|
+
5. **🔐 Security** - Prevents unauthorized operations while being helpful
|
|
430
430
|
|
|
431
431
|
### Troubleshooting Permission Errors
|
|
432
432
|
|
|
@@ -461,7 +461,7 @@ After (DDL enabled):
|
|
|
461
461
|
|
|
462
462
|
---
|
|
463
463
|
|
|
464
|
-
##
|
|
464
|
+
## 🛠️ Available Tools
|
|
465
465
|
|
|
466
466
|
The MCP server provides **30 powerful tools**:
|
|
467
467
|
|
|
@@ -485,7 +485,9 @@ The MCP server provides **30 powerful tools**:
|
|
|
485
485
|
|
|
486
486
|
### Bulk Operations (3 tools)
|
|
487
487
|
|
|
488
|
-
| Tool | Description |
|
|
488
|
+
| Tool | Description |
|
|
489
|
+
|
|
490
|
+
| Performance |
|
|
489
491
|
|------|-------------|-------------|
|
|
490
492
|
| `bulk_insert` | Insert multiple records in batches for optimal performance | Up to 10,000 records per batch |
|
|
491
493
|
| `bulk_update` | Update multiple records with different conditions in batches | Up to 1,000 operations per batch |
|
|
@@ -538,31 +540,30 @@ The MCP server provides **30 powerful tools**:
|
|
|
538
540
|
|
|
539
541
|
---
|
|
540
542
|
|
|
541
|
-
##
|
|
543
|
+
## 📚 Detailed Documentation
|
|
542
544
|
|
|
543
545
|
For comprehensive documentation on all features, please see **[DOCUMENTATIONS.md](DOCUMENTATIONS.md)** which includes:
|
|
544
546
|
|
|
545
|
-
-
|
|
546
|
-
-
|
|
547
|
-
-
|
|
548
|
-
-
|
|
549
|
-
-
|
|
550
|
-
-
|
|
551
|
-
-
|
|
552
|
-
-
|
|
553
|
-
-
|
|
554
|
-
-
|
|
555
|
-
-
|
|
547
|
+
- 🗃️ **DDL Operations** - Create, alter, and drop tables
|
|
548
|
+
- 📤 **Data Export Tools** - Export data to CSV format
|
|
549
|
+
- 💎 **Transaction Management** - ACID transactions with BEGIN, COMMIT, ROLLBACK
|
|
550
|
+
- 🔧 **Stored Procedures** - Create and execute stored procedures with IN/OUT/INOUT parameters
|
|
551
|
+
- 📋 **Usage Examples** - Real-world examples for all tools
|
|
552
|
+
- 🔍 **Query Logging & Automatic SQL Display** - See all SQL queries executed automatically
|
|
553
|
+
- 🔐 **Security Features** - Built-in security and best practices
|
|
554
|
+
- 🚀 **Bulk Operations** - High-performance batch processing
|
|
555
|
+
- 🛠️ **Troubleshooting** - Common issues and solutions
|
|
556
|
+
- 📄 **License** - MIT License details
|
|
557
|
+
- 🗺️ **Roadmap** - Upcoming features and improvements
|
|
556
558
|
|
|
557
559
|
---
|
|
558
560
|
|
|
559
|
-
##
|
|
561
|
+
## 📄 License
|
|
560
562
|
|
|
561
563
|
MIT License - see [LICENSE](LICENSE) file for details.
|
|
562
564
|
|
|
563
565
|
---
|
|
564
566
|
|
|
565
|
-
**Made with
|
|
567
|
+
**Made with ❤️ for the AI community**
|
|
566
568
|
|
|
567
569
|
*Help AI agents interact with MySQL databases safely and efficiently!*
|
|
568
|
-
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@berthojoris/mcp-mysql-server",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.15",
|
|
4
4
|
"description": "Model Context Protocol server for MySQL database integration with dynamic per-project permissions and data export capabilities",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|