@berthojoris/mcp-mysql-server 1.0.0

package/dist/validation/schemas.js

@@ -0,0 +1,287 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateShowCreateProcedure = exports.validateDropStoredProcedure = exports.validateStoredProcedureCreation = exports.validateStoredProcedureExecution = exports.validateGetStoredProcedureInfo = exports.validateListStoredProcedures = exports.validateExecuteInTransaction = exports.validateGetTransactionStatus = exports.validateRollbackTransaction = exports.validateCommitTransaction = exports.validateBeginTransaction = exports.validateGetTableRelationships = exports.validateRunQuery = exports.validateDeleteRecord = exports.validateUpdateRecord = exports.validateReadRecords = exports.validateCreateRecord = exports.validateReadTableSchema = exports.validateListTables = exports.showCreateProcedureSchema = exports.dropStoredProcedureSchema = exports.createStoredProcedureSchema = exports.executeStoredProcedureSchema = exports.getStoredProcedureInfoSchema = exports.listStoredProceduresSchema = exports.executeInTransactionSchema = exports.getTransactionStatusSchema = exports.rollbackTransactionSchema = exports.commitTransactionSchema = exports.beginTransactionSchema = exports.getTableRelationshipsSchema = exports.runQuerySchema = exports.deleteRecordSchema = exports.updateRecordSchema = exports.readRecordsSchema = exports.createRecordSchema = exports.readTableSchemaSchema = exports.listTablesSchema = void 0;
+const ajv_1 = __importDefault(require("ajv"));
+const ajv = new ajv_1.default();
+// Schema definitions
+exports.listTablesSchema = {
+    type: 'object',
+    properties: {
+        database: { type: 'string', nullable: true }
+    },
+    additionalProperties: false
+};
+exports.readTableSchemaSchema = {
+    type: 'object',
+    required: ['table_name'],
+    properties: {
+        table_name: { type: 'string' }
+    },
+    additionalProperties: false
+};
+exports.createRecordSchema = {
+    type: 'object',
+    required: ['table_name', 'data'],
+    properties: {
+        table_name: { type: 'string' },
+        data: {
+            type: 'object',
+            additionalProperties: true
+        }
+    },
+    additionalProperties: false
+};
+exports.readRecordsSchema = {
+    type: 'object',
+    required: ['table_name'],
+    properties: {
+        table_name: { type: 'string' },
+        filters: {
+            type: 'array',
+            items: {
+                type: 'object',
+                required: ['field', 'operator', 'value'],
+                properties: {
+                    field: { type: 'string' },
+                    operator: {
+                        type: 'string',
+                        enum: ['eq', 'neq', 'gt', 'gte', 'lt', 'lte', 'like', 'in']
+                    },
+                    value: {}
+                }
+            },
+            nullable: true
+        },
+        pagination: {
+            type: 'object',
+            properties: {
+                page: { type: 'integer', minimum: 1 },
+                limit: { type: 'integer', minimum: 1, maximum: 1000 }
+            },
+            required: ['page', 'limit'],
+            nullable: true
+        },
+        sorting: {
+            type: 'object',
+            properties: {
+                field: { type: 'string' },
+                direction: { type: 'string', enum: ['asc', 'desc'] }
+            },
+            required: ['field', 'direction'],
+            nullable: true
+        }
+    },
+    additionalProperties: false
+};
+exports.updateRecordSchema = {
+    type: 'object',
+    required: ['table_name', 'data', 'conditions'],
+    properties: {
+        table_name: { type: 'string' },
+        data: {
+            type: 'object',
+            additionalProperties: true
+        },
+        conditions: {
+            type: 'array',
+            items: {
+                type: 'object',
+                required: ['field', 'operator', 'value'],
+                properties: {
+                    field: { type: 'string' },
+                    operator: {
+                        type: 'string',
+                        enum: ['eq', 'neq', 'gt', 'gte', 'lt', 'lte', 'like', 'in']
+                    },
+                    value: {}
+                }
+            }
+        }
+    },
+    additionalProperties: false
+};
+exports.deleteRecordSchema = {
+    type: 'object',
+    required: ['table_name', 'conditions'],
+    properties: {
+        table_name: { type: 'string' },
+        conditions: {
+            type: 'array',
+            items: {
+                type: 'object',
+                required: ['field', 'operator', 'value'],
+                properties: {
+                    field: { type: 'string' },
+                    operator: {
+                        type: 'string',
+                        enum: ['eq', 'neq', 'gt', 'gte', 'lt', 'lte', 'like', 'in']
+                    },
+                    value: {}
+                }
+            }
+        }
+    },
+    additionalProperties: false
+};
+exports.runQuerySchema = {
+    type: 'object',
+    required: ['query'],
+    properties: {
+        query: { type: 'string' },
+        params: {
+            type: 'array',
+            items: {},
+            nullable: true
+        }
+    },
+    additionalProperties: false
+};
+exports.getTableRelationshipsSchema = {
+    type: 'object',
+    required: ['table_name'],
+    properties: {
+        table_name: { type: 'string' }
+    },
+    additionalProperties: false
+};
+// Transaction Schemas
+exports.beginTransactionSchema = {
+    type: 'object',
+    properties: {
+        transactionId: { type: 'string', nullable: true }
+    },
+    additionalProperties: false
+};
+exports.commitTransactionSchema = {
+    type: 'object',
+    required: ['transactionId'],
+    properties: {
+        transactionId: { type: 'string' }
+    },
+    additionalProperties: false
+};
+exports.rollbackTransactionSchema = {
+    type: 'object',
+    required: ['transactionId'],
+    properties: {
+        transactionId: { type: 'string' }
+    },
+    additionalProperties: false
+};
+exports.getTransactionStatusSchema = {
+    type: 'object',
+    properties: {},
+    additionalProperties: false
+};
+exports.executeInTransactionSchema = {
+    type: 'object',
+    required: ['transactionId', 'query'],
+    properties: {
+        transactionId: { type: 'string' },
+        query: { type: 'string' },
+        params: {
+            type: 'array',
+            items: {},
+            nullable: true
+        }
+    },
+    additionalProperties: false
+};
+// Stored procedure schemas
+exports.listStoredProceduresSchema = {
+    type: 'object',
+    properties: {
+        database: { type: 'string', nullable: true }
+    },
+    additionalProperties: false
+};
+exports.getStoredProcedureInfoSchema = {
+    type: 'object',
+    required: ['procedure_name'],
+    properties: {
+        procedure_name: { type: 'string' },
+        database: { type: 'string', nullable: true }
+    },
+    additionalProperties: false
+};
+exports.executeStoredProcedureSchema = {
+    type: 'object',
+    required: ['procedure_name'],
+    properties: {
+        procedure_name: { type: 'string' },
+        parameters: {
+            type: 'array',
+            items: {},
+            nullable: true
+        },
+        database: { type: 'string', nullable: true }
+    },
+    additionalProperties: false
+};
+exports.createStoredProcedureSchema = {
+    type: 'object',
+    required: ['procedure_name', 'body'],
+    properties: {
+        procedure_name: { type: 'string' },
+        parameters: {
+            type: 'array',
+            items: {
+                type: 'object',
+                required: ['name', 'mode', 'data_type'],
+                properties: {
+                    name: { type: 'string' },
+                    mode: { type: 'string', enum: ['IN', 'OUT', 'INOUT'] },
+                    data_type: { type: 'string' }
+                }
+            },
+            nullable: true
+        },
+        body: { type: 'string' },
+        comment: { type: 'string', nullable: true },
+        database: { type: 'string', nullable: true }
+    },
+    additionalProperties: false
+};
+exports.dropStoredProcedureSchema = {
+    type: 'object',
+    required: ['procedure_name'],
+    properties: {
+        procedure_name: { type: 'string' },
+        if_exists: { type: 'boolean', nullable: true },
+        database: { type: 'string', nullable: true }
+    },
+    additionalProperties: false
+};
+exports.showCreateProcedureSchema = {
+    type: 'object',
+    required: ['procedure_name'],
+    properties: {
+        procedure_name: { type: 'string' },
+        database: { type: 'string', nullable: true }
+    },
+    additionalProperties: false
+};
+// Compile validators
+exports.validateListTables = ajv.compile(exports.listTablesSchema);
+exports.validateReadTableSchema = ajv.compile(exports.readTableSchemaSchema);
+exports.validateCreateRecord = ajv.compile(exports.createRecordSchema);
+exports.validateReadRecords = ajv.compile(exports.readRecordsSchema);
+exports.validateUpdateRecord = ajv.compile(exports.updateRecordSchema);
+exports.validateDeleteRecord = ajv.compile(exports.deleteRecordSchema);
+exports.validateRunQuery = ajv.compile(exports.runQuerySchema);
+exports.validateGetTableRelationships = ajv.compile(exports.getTableRelationshipsSchema);
+exports.validateBeginTransaction = ajv.compile(exports.beginTransactionSchema);
+exports.validateCommitTransaction = ajv.compile(exports.commitTransactionSchema);
+exports.validateRollbackTransaction = ajv.compile(exports.rollbackTransactionSchema);
+exports.validateGetTransactionStatus = ajv.compile(exports.getTransactionStatusSchema);
+exports.validateExecuteInTransaction = ajv.compile(exports.executeInTransactionSchema);
+// Stored procedure validators
+exports.validateListStoredProcedures = ajv.compile(exports.listStoredProceduresSchema);
+exports.validateGetStoredProcedureInfo = ajv.compile(exports.getStoredProcedureInfoSchema);
+exports.validateStoredProcedureExecution = ajv.compile(exports.executeStoredProcedureSchema);
+exports.validateStoredProcedureCreation = ajv.compile(exports.createStoredProcedureSchema);
+exports.validateDropStoredProcedure = ajv.compile(exports.dropStoredProcedureSchema);
+exports.validateShowCreateProcedure = ajv.compile(exports.showCreateProcedureSchema);

package/manifest.json

@@ -0,0 +1,248 @@
+{
+  "name": "mysql-mcp",
+  "description": "A Model Context Protocol for MySQL database interaction",
+  "version": "1.0.0",
+  "tools": [
+    {
+      "name": "list_databases",
+      "description": "Lists all databases available on the MySQL server.",
+      "input_schema": {},
+      "output_schema": {
+        "type": "array",
+        "items": { "type": "string" }
+      }
+    },
+    {
+      "name": "list_tables",
+      "description": "Lists all tables in the connected MySQL database.",
+      "input_schema": {},
+      "output_schema": {
+        "type": "array",
+        "items": { "type": "string" }
+      }
+    },
+    {
+      "name": "read_table_schema",
+      "description": "Reads the schema of a specified table.",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "table_name": { "type": "string" }
+        },
+        "required": ["table_name"]
+      },
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "columns": { 
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": { "type": "string" },
+                "type": { "type": "string" },
+                "nullable": { "type": "boolean" },
+                "default": { "type": ["string", "null"] },
+                "primary_key": { "type": "boolean" }
+              }
+            }
+          },
+          "primary_key": { "type": ["string", "null"] },
+          "indexes": { 
+            "type": "array",
+            "items": { "type": "string" }
+          }
+        }
+      }
+    },
+    {
+      "name": "create_record",
+      "description": "Creates a new record in the specified table.",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "table_name": { "type": "string" },
+          "data": { "type": "object" }
+        },
+        "required": ["table_name", "data"]
+      },
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "success": { "type": "boolean" },
+          "id": { "type": ["string", "number"] },
+          "affected_rows": { "type": "number" }
+        }
+      }
+    },
+    {
+      "name": "read_records",
+      "description": "Reads records from the specified table with optional filtering, pagination, and sorting.",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "table_name": { "type": "string" },
+          "filters": { "type": "object" },
+          "limit": { "type": "number" },
+          "offset": { "type": "number" },
+          "sort_by": { "type": "string" },
+          "sort_direction": { "type": "string", "enum": ["ASC", "DESC"] }
+        },
+        "required": ["table_name"]
+      },
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "records": { "type": "array" },
+          "total": { "type": "number" }
+        }
+      }
+    },
+    {
+      "name": "update_record",
+      "description": "Updates an existing record in the specified table.",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "table_name": { "type": "string" },
+          "id_field": { "type": "string" },
+          "id": { "type": ["string", "number"] },
+          "data": { "type": "object" }
+        },
+        "required": ["table_name", "id", "data"]
+      },
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "success": { "type": "boolean" },
+          "affected_rows": { "type": "number" }
+        }
+      }
+    },
+    {
+      "name": "delete_record",
+      "description": "Deletes a record from the specified table.",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "table_name": { "type": "string" },
+          "id_field": { "type": "string" },
+          "id": { "type": ["string", "number"] }
+        },
+        "required": ["table_name", "id"]
+      },
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "success": { "type": "boolean" },
+          "affected_rows": { "type": "number" }
+        }
+      }
+    },
+    {
+      "name": "run_query",
+      "description": "Runs a read-only SQL query with optional parameters.",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "query": { "type": "string" },
+          "params": { "type": "array" }
+        },
+        "required": ["query"]
+      },
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "results": { "type": "array" },
+          "fields": { "type": "array" }
+        }
+      }
+    },
+    {
+      "name": "execute_sql",
+      "description": "Executes a write SQL operation (INSERT, UPDATE, DELETE) with optional parameters.",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "query": { "type": "string" },
+          "params": { "type": "array" }
+        },
+        "required": ["query"]
+      },
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "success": { "type": "boolean" },
+          "affected_rows": { "type": "number" },
+          "insert_id": { "type": ["number", "null"] }
+        }
+      }
+    },
+    {
+      "name": "describe_connection",
+      "description": "Returns information about the current database connection.",
+      "input_schema": {},
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "host": { "type": "string" },
+          "port": { "type": "number" },
+          "database": { "type": "string" },
+          "user": { "type": "string" },
+          "connected": { "type": "boolean" }
+        }
+      }
+    },
+    {
+      "name": "test_connection",
+      "description": "Tests the database connection and returns latency information.",
+      "input_schema": {},
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "success": { "type": "boolean" },
+          "latency_ms": { "type": "number" },
+          "message": { "type": "string" }
+        }
+      }
+    },
+    {
+      "name": "get_table_relationships",
+      "description": "Returns foreign key relationships for a specified table.",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "table_name": { "type": "string" }
+        },
+        "required": ["table_name"]
+      },
+      "output_schema": {
+        "type": "object",
+        "properties": {
+          "as_parent": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "table": { "type": "string" },
+                "column": { "type": "string" },
+                "referenced_column": { "type": "string" }
+              }
+            }
+          },
+          "as_child": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "table": { "type": "string" },
+                "column": { "type": "string" },
+                "referenced_column": { "type": "string" }
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@berthojoris/mcp-mysql-server",
+  "version": "1.0.0",
+  "description": "Model Context Protocol server for MySQL database integration with dynamic per-project permissions",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "mcp-mysql": "./bin/mcp-mysql.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/server.js",
+    "start:mcp": "node dist/mcp-server.js",
+    "start:api": "node dist/server.js",
+    "dev": "ts-node src/index.ts",
+    "dev:mcp": "ts-node src/mcp-server.ts",
+    "dev:api": "ts-node src/server.ts",
+    "test": "jest",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "mcp",
+    "mysql",
+    "database",
+    "llm",
+    "ai",
+    "model-context-protocol",
+    "claude",
+    "cline",
+    "windsurf",
+    "agent",
+    "database-tools",
+    "sql",
+    "mysql-client",
+    "ai-tools"
+  ],
+  "author": "Your Name <your.email@example.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/your-username/mcp-mysql.git"
+  },
+  "bugs": {
+    "url": "https://github.com/your-username/mcp-mysql/issues"
+  },
+  "homepage": "https://github.com/your-username/mcp-mysql#readme",
+  "files": [
+    "dist",
+    "bin",
+    "README.md",
+    "LICENSE",
+    "manifest.json"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.20.0",
+    "ajv": "^8.12.0",
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2",
+    "express-rate-limit": "^7.1.5",
+    "helmet": "^7.1.0",
+    "jsonwebtoken": "^9.0.2",
+    "morgan": "^1.10.0",
+    "mysql2": "^3.6.1",
+    "winston": "^3.11.0"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.4",
+    "@types/jsonwebtoken": "^9.0.5",
+    "@types/morgan": "^1.9.9",
+    "@types/node": "^20.6.0",
+    "jest": "^29.6.4",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
+  }
+}