MCP Server Mariadb Reader

🚀 MariaDB Reader MCP Server

This project is a Model Context Protocol (MCP) server for exploring and interacting with MariaDB databases. The server provides tools for AI assistants like Cline to access MariaDB databases and retrieve information.

🚀 Quick Start

This MCP server is designed to enable AI assistants to access and interact with MariaDB databases. To get started, simply clone the GitHub repository and register the server information in the settings file of your MCP client (e.g., a VS Code extension).

✨ Features

This MCP server offers the following features:

• list_databases: Returns a list of all accessible databases.
• list_tables: Returns a list of all tables in the specified database.
  • Input: database (string, required) - The name of the database to query for the table list.
• get_table_schema: Returns the schema (column definitions) of the specified table.
  • Input:
    • database (string, required) - The name of the database the table belongs to.
    • table (string, required) - The name of the table to query the schema for.
• query_table: Queries data from the specified table. By default, it returns the first 100 rows.
  • Input:
    • database (string, required) - The name of the database the table belongs to.
    • table (string, required) - The name of the table to query data from.
    • limit (number, optional) - The maximum number of rows to return (default: 100).

📦 Installation

To use this server, clone the GitHub repository and register the server information in the settings file of your MCP client (e.g., a VS Code extension). The repository includes a pre-built executable file (build/index.js), so no additional build steps are required.

Clone the repository

git clone https://github.com/moosin76/mcp_server_mariadb_reader.git

Modify the MCP settings file

Example settings:

{
  "mcpServers": {
    "mcp_server_mariadb_reader": {
      "command": "node",
      "args": ["<Actual path of the cloned repository>/build/index.js"], // Path to the build/index.js file in the cloned repository
      "env": {
        "MARIADB_HOST": "YOUR_DB_HOST",         // MariaDB server address
        "MARIADB_PORT": "YOUR_DB_PORT",         // MariaDB port number (e.g., "3306")
        "MARIADB_USER": "YOUR_DB_USER",         // MariaDB username
        "MARIADB_PASSWORD": "YOUR_DB_PASSWORD", // MariaDB password
        "MARIADB_DATABASE": "YOUR_DEFAULT_DB"   // (Optional) Default database name
      },
      "disabled": false,
      "autoApprove": []
    }
    // Other MCP server settings...
  }
}

Note:

• Replace <Actual path of the cloned repository> with the actual local path where you cloned the repository. (e.g., C:/Users/YourUser/Documents/GitHub/mcp_server_mariadb_reader)
• Modify the placeholders in the env object, such as YOUR_DB_HOST, etc.

🔧 Technical Details

Development

To make modifications to the source code, follow these steps:

1. Install dependencies:

npm install

2. Build the project:

npm run build

3. Use live monitoring (optional):

npm run watch

📄 License

This project is distributed under [License information to be added].