Db MCP Tool

🚀 Database Explorer MCP Tool

A powerful Model Context Protocol (MCP) tool for exploring and managing various types of databases, including PostgreSQL, MySQL, and Firestore.

✨ Features

• Multi-database Support
  • PostgreSQL
  • MySQL
  • Firestore
• Database Operations
  • Connect to databases
  • List tables
  • View triggers
  • List functions
  • Execute SQL queries (PostgreSQL and MySQL)
  • Export table structures
  • Export table data

📦 Integration with Cursor

Before adding the tool to Cursor, you need to build the project:

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

Steps to add the tool to Cursor:

1. Open Cursor settings.
2. Navigate to the "Model Context Protocol (MCP)" section.
3. Click "Add New Tool".
4. Fill in the following details:

   {
     "name": "database-explorer",
     "command": "node /path/to/project/dist/index.js",
     "description": "Database Explorer MCP Tool"
   }
   

   ⚠️ Important Note: Replace /path/to/project with the actual project directory path.
5. Save the settings.
6. Restart Cursor.

💻 Usage Examples

Basic Usage

After setting up, you can use one of the following commands to connect to a database:

• For PostgreSQL: Use !pg followed by connection information.
• For MySQL: Use !mysql followed by connection information.
• For Firestore: Use !firestore followed by connection information.

Once connected, you can perform various database operations:

• !tables to list all tables.
• !triggers to view triggers.
• !functions to list functions.
• !query to execute SQL queries.
• !export-db to export table structures.
• !export-data to export table data.

Commands

Connection Commands

• !pg - Connect to a PostgreSQL database

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

• !mysql - Connect to a MySQL database

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

• !firestore - Connect to a Firestore database

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

Database Requirements

• PostgreSQL Driver: pg
• MySQL Driver: mysql
• Firestore Driver: firestore

⚠️ Important Note

• Ensure that the correct database drivers are installed.
• Replace /path/to/project with the actual project path.
• When using !export-db and !export-data, ensure that you have sufficient permissions to access tables and data.