使用说明

项目简介

database-updater MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在提供数据库批量更新和数据管理能力。它通过工具的形式,允许用户从 CSV 或 Excel 文件中读取数据,并将其批量更新到多种类型的数据库中。此外,服务器还提供简单的笔记功能,方便用户记录和管理数据库更新的相关信息。

主要功能点

  • 数据库批量更新: 通过 'update_database' 工具,支持将 CSV 和 Excel (.xlsx, .xls) 文件的数据批量更新到 PostgreSQL, MySQL, MongoDB, SQLite 等多种数据库。用户可以配置数据库连接信息和目标表名。
  • 笔记创建与管理: 通过 'create_note' 工具,用户可以创建和管理笔记,用于记录数据库更新的文档或重要信息,方便追踪变更和修改。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的电脑上已经安装了 Node.js 和 npm (Node Package Manager)。你可以从 nodejs.org 下载并安装。
  2. 克隆仓库: 打开终端或命令提示符,使用 'git clone https://github.com/AnuragRai017/database-updater-MCP-Server' 命令克隆仓库到本地。
  3. 进入仓库目录: 使用 'cd database-updater-MCP-Server' 命令进入克隆下来的仓库目录。
  4. 安装依赖: 运行 'npm install' 命令安装项目所需的依赖包。
  5. 构建项目: 运行 'npm run build' 命令编译 TypeScript 代码,生成可执行的 JavaScript 文件。

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)配合使用,你需要配置客户端以连接到此服务器。配置通常在客户端的配置文件中进行,例如 Claude Desktop 的 'claude_desktop_config.json' 文件。

以下是一个配置示例,你需要将其添加到客户端的配置文件中:

{
  "mcpServers": {
    "database-updater": {
      "command": "/path/to/database-updater/build/index.js"
    }
  }
}

配置参数说明:

  • '"database-updater"': 这是你为该 MCP 服务器设置的名称,可以自定义。
  • '"command"': 请将 '/path/to/database-updater/build/index.js' 替换为你本地仓库 'build' 目录下 'index.js' 文件的绝对路径。 这个路径指向服务器的启动命令。

基本使用方法

配置完成后,MCP 客户端将能够发现并连接到 database-updater MCP Server。你可以通过客户端调用服务器提供的工具和资源。

  • 使用 'update_database' 工具: 客户端可以调用 'update_database' 工具,并提供以下参数来更新数据库:
    {
      "filePath": "/path/to/your/file.csv",  // CSV 或 Excel 文件路径
      "databaseType": "PostgreSQL",         // 数据库类型 (PostgreSQL, MySQL, MongoDB, SQLite)
      "connectionString": "postgresql://user:pass@localhost:5432/db", // 数据库连接字符串
      "tableName": "target_table"            // 目标表名
    }
  • 使用 'create_note' 工具: 客户端可以调用 'create_note' 工具,并提供 'title' 和 'content' 参数来创建新的笔记。
  • 查看和使用资源: 客户端可以请求服务器列出可用的资源(例如笔记),并读取资源的内容。

请参考 MCP 客户端的文档,了解如何配置和使用 MCP 服务器,以及如何调用工具和访问资源。

信息

分类

数据库与文件