金大哥 - db-mcp-tool MCP 详情

article

README

🚀 数据库探索者 MCP 工具

一个强大的模型上下文协议（MCP）工具，用于探索和管理各种类型的数据库，包括PostgreSQL、MySQL和Firestore。它能帮助用户更高效地与不同数据库进行交互，提升数据库管理的便捷性。

🚀 快速开始

在将工具添加到Cursor之前，需要先构建项目：

克隆仓库
安装依赖项：
```
npm install
```
构建项目：
```
npm run build
```

将工具添加到Cursor的方法：

打开Cursor设置
导航到“模型上下文协议（MCP）”部分
点击“添加新工具”

填写以下详细信息：

{
  "name": "database-explorer",
  "command": "node /path/to/project/dist/index.js",
  "description": "数据库探索者 MCP 工具"
}

注意：将 /path/to/project 替换为实际项目目录路径。

保存设置
重启Cursor

使用工具：

设置完成后，您可以使用以下命令之一连接到数据库：
- 对于PostgreSQL：使用 !pg 加上连接信息
- 对于MySQL：使用 !mysql 加上连接信息
- 对于Firestore：使用 !firestore 加上连接信息
连接后，可以执行各种数据库操作：
- !tables 列出所有表
- !triggers 查看触发器
- !functions 列出函数
- !query 执行SQL查询
- !export-db 导出表结构
- !export-data 导出表数据

查看以下命令部分以获取详细使用示例。

✨ 主要特性

多数据库支持
- PostgreSQL
- MySQL
- Firestore
数据库操作
- 连接数据库
- 列出表
- 查看触发器
- 列出函数
- 执行SQL查询（PostgreSQL和MySQL）
- 导出表结构
- 导出表数据

💻 使用示例

基础用法

以下是连接不同数据库的命令示例：

连接到PostgreSQL数据库

{
    "connection": {
        "host": "hostname",
        "port": 5432,
        "database": "dbname",
        "user": "username",
        "password": "password"
    }
}

连接到MySQL数据库

{
    "connection": {
        "host": "hostname",
        "port": 3306,
        "database": "dbname",
        "user": "username",
        "password": "password"
    }
}

连接到Firestore数据库

{
    "connection": {
        "projectId": "project-id",
        "apiKey": "api-key"
    }
}

高级用法

连接数据库后，您可以执行各种数据库操作，例如：

使用 !tables 列出所有表
使用 !triggers 查看触发器
使用 !functions 列出函数
使用 !query 执行SQL查询
使用 !export-db 导出表结构
使用 !export-data 导出表数据

📚 详细文档

连接命令

!pg - 连接到PostgreSQL数据库
!mysql - 连接到MySQL数据库
!firestore - 连接到Firestore数据库

数据库要求

PostgreSQL 驱动：pg
MySQL 驱动：mysql
Firestore 驱动：firestore

⚠️ 重要提示

⚠️ 重要提示

确保安装了正确的数据库驱动

将 /path/to/project 替换为实际项目路径

在使用 !export-db 和 !export-data 时，确保有足够的权限访问表和数据

db-mcp-tool