MariaDB Reader MCP 服务器

本项目是一个用于浏览和交互 MariaDB 数据库的 Model Context Protocol (MCP) 服务器。该服务器为 Cline 等 AI 助手提供工具，使其能够访问 MariaDB 数据库并查询信息。

功能

此 MCP 服务器提供以下工具：

• list_databases: 返回所有可访问数据库的列表。
• list_tables: 返回指定数据库中的所有表列表。
  • 输入: database (字符串, 必需) - 要查询表列表的数据库名称。
• get_table_schema: 返回指定表的模式（列定义）。
  • 输入:
    • database (字符串, 必需) - 表所属的数据库名称。
    • table (字符串, 必需) - 要查询模式的表名称。
• query_table: 查询指定表中的数据。默认情况下，返回前 100 行。
  • 输入:
    • database (字符串, 必需) - 表所属的数据库名称。
    • table (字符串, 必需) - 要查询数据的表名称。
    • limit (数字, 可选) - 要返回的最大行数（默认值：100）。

配置

要使用此服务器，请克隆 GitHub 存储库，并将服务器信息注册到 MCP 客户端（例如 VS Code 扩展程序）的配置文件中。此存储库包含预构建的可执行文件 (build/index.js)，因此无需单独的构建过程。

1. 克隆存储库: 将此存储库克隆到所需位置。

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

2. 修改 MCP 配置文件:

配置示例:

{
  "mcpServers": {
    "mcp_server_mariadb_reader": {
      "command": "node",
      "args": ["<克隆的存储库路径>/build/index.js"], // 克隆的存储库内 build/index.js 文件路径
      "env": {
        "MARIADB_HOST": "YOUR_DB_HOST",         // MariaDB 主机地址
        "MARIADB_PORT": "YOUR_DB_PORT",         // MariaDB 端口号 (例如: "3306")
        "MARIADB_USER": "YOUR_DB_USER",         // MariaDB 用户名
        "MARIADB_PASSWORD": "YOUR_DB_PASSWORD", // MariaDB 密码
        "MARIADB_DATABASE": "YOUR_DEFAULT_DB"   // (可选) 默认数据库名称
      },
      "disabled": false,
      "autoApprove": []
    }
    // 其他 MCP 服务器配置...
  }
}

注意:

• <克隆的存储库路径> 部分必须更改为克隆存储库的实际本地路径。（例如：C:/Users/YourUser/Documents/GitHub/mcp_server_mariadb_reader）
• env 对象内的 MariaDB 连接信息必须根据实际环境进行修改。

开发 (修改源代码时)

此存储库包含已构建的文件，因此无需执行以下步骤即可使用服务器。 如果您想直接修改源代码（src 目录）并应用更改，请按照以下步骤操作。

1. 安装依赖项 (首次或 package.json 更改时):

   npm install
   

2. 修改后构建:

   npm run build
   

   • 此命令将 src 目录中的 TypeScript 代码编译为 build 目录中的 JavaScript 代码。
3. (可选) 开发过程中检测更改并自动构建:

   npm run watch
   

许可证

本项目在 [许可证信息输入] 许可证下发布。