Db MCP Tool

🚀 數據庫探索者 MCP 工具

數據庫探索者 MCP 工具是一款強大的模型上下文協議（MCP）工具，可用於探索和管理多種類型的數據庫，如 PostgreSQL、MySQL 和 Firestore，能有效提升數據庫管理的效率。

🚀 快速開始

在將工具添加到 Cursor 之前，需要先構建項目：

1. 克隆倉庫。
2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

將工具添加到 Cursor 的方法：

1. 打開 Cursor 設置。
2. 導航到“模型上下文協議（MCP）”部分。
3. 點擊“添加新工具”。
4. 填寫以下詳細信息：

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

⚠️ 注意：將 /path/to/project 替換為實際項目目錄路徑。 5. 保存設置。 6. 重啟 Cursor。

使用工具：

1. 設置完成後，您可以使用以下命令之一連接到數據庫：
   • 對於 PostgreSQL：使用 !pg 加上連接信息。
   • 對於 MySQL：使用 !mysql 加上連接信息。
   • 對於 Firestore：使用 !firestore 加上連接信息。
2. 連接後，可以執行各種數據庫操作：
   • !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"
    }
}

高級用法

使用 !query 執行 SQL 查詢示例：

// 假設已連接到 PostgreSQL 數據庫
{
    "query": "SELECT * FROM your_table"
}

📚 詳細文檔

連接命令

• !pg - 連接到 PostgreSQL 數據庫

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

• !mysql - 連接到 MySQL 數據庫

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

• !firestore - 連接到 Firestore 數據庫

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

數據庫要求

⚠️ 重要提示

• 確保安裝了正確的數據庫驅動。
• 將 /path/to/project 替換為實際項目路徑。
• 在使用 !export-db 和 !export-data 時，確保有足夠的權限訪問表和數據。