MariaDB Reader MCP Server

MariaDB Reader MCP Server

本项目是一个用于浏览和交互 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
   

许可证

本项目根据 [输入许可证信息] 许可证进行分发。