diff --git a/docs/docs/connection-reference.md b/docs/docs/connection-reference.md index 7cf0670..b38da52 100644 --- a/docs/docs/connection-reference.md +++ b/docs/docs/connection-reference.md @@ -68,6 +68,25 @@ node dist/src/index.js --postgresql --host localhost --database sample_db --user node dist/src/index.js --postgresql --host dbserver.example.com --database sample_db --user appuser --password Secure123! --port 5433 --ssl true ``` +## MySQL Connection Options + +| Option | Description | Default | Required | +|--------|-------------|---------|----------| +| `--mysql` | Specifies MySQL mode | - | Yes | +| `--host` | MySQL hostname or IP | - | Yes | +| `--database` | Database name | - | Yes | +| `--user` | MySQL username | - | No | +| `--password` | MySQL password | - | No | +| `--port` | MySQL port | 3306 | No | +| `--ssl` | Use SSL connection (true/false or object) | false | No | +| `--connection-timeout` | Connection timeout in ms | 30000 | No | + +### Example + +```bash +node dist/src/index.js --mysql --host localhost --database sample_db --port 3306 --user root --password secret +``` + ## Environment Variables Instead of specifying sensitive credentials on the command line, you can use environment variables: diff --git a/docs/docs/release-notes.md b/docs/docs/release-notes.md index 1140b9b..4deceb6 100644 --- a/docs/docs/release-notes.md +++ b/docs/docs/release-notes.md @@ -53,4 +53,12 @@ - Table management (CREATE, ALTER, DROP) - Schema introspection - MCP integration for Claude Desktop -- Node.js-based implementation for cross-platform support \ No newline at end of file +- Node.js-based implementation for cross-platform support + +## 1.1.0 (2024-05-30) + +### Features +- Added MySQL database support (read/write/query, schema, etc.) +- Support for passing MySQL port via CLI and config +- Improved port validation and debug logging for MySQL +- Updated documentation and examples for MySQL and port usage \ No newline at end of file diff --git a/index.ts b/index.ts index 1b130f8..8fe5805 100644 --- a/index.ts +++ b/index.ts @@ -14,7 +14,7 @@ import sqlite3 from "sqlite3"; const server = new Server( { name: "executeautomation/database-server", - version: "1.0.0", + version: "1.1.0", }, { capabilities: { diff --git a/package.json b/package.json index 2c33d63..7a95a2d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@executeautomation/database-server", - "version": "1.0.2", + "version": "1.1.0", "description": "MCP server for interacting with SQLite and SQL Server databases by ExecuteAutomation", "license": "MIT", "author": "ExecuteAutomation, Ltd (https://executeautomation.com)", diff --git a/readme.md b/readme.md index 2e3cc47..890f4ac 100644 --- a/readme.md +++ b/readme.md @@ -97,17 +97,17 @@ Optional parameters: To use with a MySQL database: ``` -node dist/src/index.js --mysql --host --database [--user --password ] +node dist/src/index.js --mysql --host --database --port [--user --password ] ``` Required parameters: - `--host`: MySQL host name or IP address - `--database`: Name of the database +- `--port`: Port number (default: 3306) Optional parameters: - `--user`: Username for MySQL authentication - `--password`: Password for MySQL authentication -- `--port`: Port number (default: 3306) - `--ssl`: Enable SSL connection (true/false or object) - `--connection-timeout`: Connection timeout in milliseconds (default: 30000) @@ -160,6 +160,7 @@ If you installed the package globally, configure Claude Desktop with: "--mysql", "--host", "your-host-name", "--database", "your-database-name", + "--port", "3306", "--user", "your-username", "--password", "your-password" ] @@ -211,6 +212,7 @@ For local development, configure Claude Desktop to use your locally built versio "--mysql", "--host", "your-host-name", "--database", "your-database-name", + "--port", "3306", "--user", "your-username", "--password", "your-password" ] diff --git a/src/index.ts b/src/index.ts index 691a7ad..b23d142 100644 --- a/src/index.ts +++ b/src/index.ts @@ -28,7 +28,7 @@ const logger = { const server = new Server( { name: "executeautomation/database-server", - version: "1.0.1", + version: "1.1.0", }, { capabilities: {