Skip to content

Commit 2d29108

Browse files
committed
Update version to 1.1.0 and enhance MySQL documentation
Bumped version to 1.1.0 in index.ts and package.json. Updated README and connection reference documentation to include MySQL port option and usage examples. Added release notes for new features and improvements related to MySQL support.
1 parent 674cf50 commit 2d29108

File tree

6 files changed

+35
-6
lines changed

6 files changed

+35
-6
lines changed

docs/docs/connection-reference.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,25 @@ node dist/src/index.js --postgresql --host localhost --database sample_db --user
6868
node dist/src/index.js --postgresql --host dbserver.example.com --database sample_db --user appuser --password Secure123! --port 5433 --ssl true
6969
```
7070

71+
## MySQL Connection Options
72+
73+
| Option | Description | Default | Required |
74+
|--------|-------------|---------|----------|
75+
| `--mysql` | Specifies MySQL mode | - | Yes |
76+
| `--host` | MySQL hostname or IP | - | Yes |
77+
| `--database` | Database name | - | Yes |
78+
| `--user` | MySQL username | - | No |
79+
| `--password` | MySQL password | - | No |
80+
| `--port` | MySQL port | 3306 | No |
81+
| `--ssl` | Use SSL connection (true/false or object) | false | No |
82+
| `--connection-timeout` | Connection timeout in ms | 30000 | No |
83+
84+
### Example
85+
86+
```bash
87+
node dist/src/index.js --mysql --host localhost --database sample_db --port 3306 --user root --password secret
88+
```
89+
7190
## Environment Variables
7291

7392
Instead of specifying sensitive credentials on the command line, you can use environment variables:

docs/docs/release-notes.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,12 @@
5353
- Table management (CREATE, ALTER, DROP)
5454
- Schema introspection
5555
- MCP integration for Claude Desktop
56-
- Node.js-based implementation for cross-platform support
56+
- Node.js-based implementation for cross-platform support
57+
58+
## 1.1.0 (2024-05-30)
59+
60+
### Features
61+
- Added MySQL database support (read/write/query, schema, etc.)
62+
- Support for passing MySQL port via CLI and config
63+
- Improved port validation and debug logging for MySQL
64+
- Updated documentation and examples for MySQL and port usage

index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import sqlite3 from "sqlite3";
1414
const server = new Server(
1515
{
1616
name: "executeautomation/database-server",
17-
version: "1.0.0",
17+
version: "1.1.0",
1818
},
1919
{
2020
capabilities: {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@executeautomation/database-server",
3-
"version": "1.0.2",
3+
"version": "1.1.0",
44
"description": "MCP server for interacting with SQLite and SQL Server databases by ExecuteAutomation",
55
"license": "MIT",
66
"author": "ExecuteAutomation, Ltd (https://executeautomation.com)",

readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,17 +97,17 @@ Optional parameters:
9797
To use with a MySQL database:
9898

9999
```
100-
node dist/src/index.js --mysql --host <host-name> --database <database-name> [--user <username> --password <password>]
100+
node dist/src/index.js --mysql --host <host-name> --database <database-name> --port <port> [--user <username> --password <password>]
101101
```
102102

103103
Required parameters:
104104
- `--host`: MySQL host name or IP address
105105
- `--database`: Name of the database
106+
- `--port`: Port number (default: 3306)
106107

107108
Optional parameters:
108109
- `--user`: Username for MySQL authentication
109110
- `--password`: Password for MySQL authentication
110-
- `--port`: Port number (default: 3306)
111111
- `--ssl`: Enable SSL connection (true/false or object)
112112
- `--connection-timeout`: Connection timeout in milliseconds (default: 30000)
113113

@@ -160,6 +160,7 @@ If you installed the package globally, configure Claude Desktop with:
160160
"--mysql",
161161
"--host", "your-host-name",
162162
"--database", "your-database-name",
163+
"--port", "3306",
163164
"--user", "your-username",
164165
"--password", "your-password"
165166
]
@@ -211,6 +212,7 @@ For local development, configure Claude Desktop to use your locally built versio
211212
"--mysql",
212213
"--host", "your-host-name",
213214
"--database", "your-database-name",
215+
"--port", "3306",
214216
"--user", "your-username",
215217
"--password", "your-password"
216218
]

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ const logger = {
2828
const server = new Server(
2929
{
3030
name: "executeautomation/database-server",
31-
version: "1.0.1",
31+
version: "1.1.0",
3232
},
3333
{
3434
capabilities: {

0 commit comments

Comments
 (0)