Mariadb MCP Server

🚀 MariaDB/MySQL MCP Server

The MariaDB/MySQL MCP Server is a powerful tool for managing databases, providing functions such as database creation, deletion, and data manipulation.

🚀 Quick Start

To quickly start using the MariaDB/MySQL MCP Server, you need to complete the installation, configuration, and startup steps.

📦 Installation

There are two ways to install the MariaDB/MySQL MCP Server:

1. Install from NPM

You can install the MariaDB/MySQL MCP Server into your system using the following command:

npm install -g mariadb-mcp-server

2. Build from Source Code

If you wish to build from source code, follow these steps:

1. Clone the repository:

git clone https://github.com/yourusername/mariaDB-mcp-server.git
cd mariaDB-mcp-server

2. Install dependencies:

npm install

3. Build the project:

npm run build

🛠️ Configuration

Environment Variable Configuration

Before running the server, make sure to set the following environment variables:

• MARIADB_HOST: The database host address, defaulting to localhost.
• MARIADB_PORT: The database port number, defaulting to 3306.
• MARIADB_USER: The database username.
• MARIADB_PASSWORD: The database user password.

Configuration File

You can find the config.json file in the project's root directory, which is used to configure other parameters of the server, for example:

{
  "port": 3000,
  "debug": false,
  "logLevel": "info"
}

🚀 Start the Server

The command to start the server is as follows:

npm start

✨ Features

1. Database Management

• Create a Database:

CREATE DATABASE your_database;

• Delete a Database:

DROP DATABASE your_database;

• Use a Database:

USE your_database;

2. Table Management

• Create a Table:

CREATE TABLE users (
  id INT AUTO_INCREMENT PRIMARY KEY,
  username VARCHAR(50) NOT NULL,
  email VARCHAR(100) NOT NULL UNIQUE
);

• Delete a Table:

DROP TABLE users;

3. Data Manipulation

• Insert Data:

INSERT INTO users (username, email) VALUES ('john', 'john@example.com');

• Query Data:

SELECT * FROM users WHERE id = 1;

• Update Data:

UPDATE users SET username = 'johndoe' WHERE id = 1;

• Delete Data:

DELETE FROM users WHERE id = 1;

💻 Usage Examples

Create a User Table and Insert Data

CREATE TABLE users (
  id INT AUTO_INCREMENT PRIMARY KEY,
  username VARCHAR(50) NOT NULL,
  email VARCHAR(100) NOT NULL UNIQUE
);

INSERT INTO users (username, email) VALUES ('alice', 'alice@example.com');

Query All Data in the User Table

SELECT * FROM users;

⚠️ Error Handling

Common Errors and Solutions

1. Connection Timeout

   • Check if the database service is running.
   • Ensure that the firewall is not blocking port 3306.

2. Insufficient Permissions

   • Ensure that the database user has sufficient permissions.
   • Use the following commands to grant permissions:

GRANT ALL PRIVILEGES ON *.* TO 'your_user'@'localhost' IDENTIFIED BY 'your_password';
FLUSH PRIVILEGES;

3. Syntax Error
   • Check if the SQL statement syntax is correct.
   • Use a database management tool to verify the query.

📚 Documentation

References

• MariaDB Official Documentation
• MySQL Official Documentation
• Developed based on Lucas's MySQL MCP Server