DB Connector (MySQL/PostgreSQL)

🚀 DB MCP Server

DB MCP Server is a powerful tool designed to facilitate database operations. It provides a simple and efficient way to interact with databases through different modes, such as SSE and HTTP.

🚀 Quick Start

To quickly get the DB MCP Server up and running, follow these steps:

1. Download the source code:

   git clone https://github.com/FreePeak/db-mcp-server.git
   cd db-mcp-server
   

2. Install dependencies: In the project root directory, execute:

   go mod tidy
   

3. Build the binary file: Compile the executable file by running the following command:

   go build -o bin/server .
   

4. Run the service: Start the server:

   ./bin/server --config=config.json
   

5. Access the documentation: Check the detailed usage instructions in the docs/ directory.

📦 Installation

Install Dependencies

Ensure that the following tools are installed:

• Go programming language environment (recommended version 1.20 or higher)
• Git for cloning the repository

Clone the Repository

Run the following commands in the terminal:

git clone https://github.com/FreePeak/db-mcp-server.git
cd db-mcp-server

Install Dependencies

Execute the following command to install the required Go packages for the project:

go mod tidy

Build the Executable

Build the server binary:

go build -o bin/server .

Configure the Service

Create a config.json configuration file and refer to the example content:

{
    "port": 9095,
    "mode": "sae", // Optional values: sae, http
    "connections": [
        {
            "id": "mysql1",
            "type": "mysql",
            "host": "localhost",
            "port": 3306,
            "user": "root",
            "password": "password",
            "name": "testdb"
        }
    ]
}

Start the Service

Run the following command to start the server:

./bin/server --config=config.json

💻 Usage Examples

Basic Usage

• SSE Mode: In a browser or other clients, you can connect in the following way:

  const eventSource = new EventSource('http://localhost:9095/sse');
  eventSource.onmessage = (event) => {
    console.log('Received:', event.data);
  };
  

• HTTP Mode: Interact through the REST API, supporting JSON requests and responses.

Configuration File Explanation

The config.json mainly contains the following configuration items:

• port: The port on which the service listens, with a default value of 9095.
• mode: The operating mode, with optional values of sae or http, and a default of sae (supporting SSE).
• connections: The database connection pool configuration, where each connection includes the following attributes:
  • id: A unique identifier.
  • type: The database type (e.g., mysql, postgres).
  • host: The database host address.
  • port: The database port.
  • user: The database username.
  • password: The user password.
  • name: The database name.

Example Usage Scenarios

• Query data:

  {
    "tool": "query_mysql",
    "params": {
      "query": "SELECT * FROM users LIMIT 10"
    }
  }
  

• Execute a transaction:

  {
    "tool": "transaction_mysql",
    "params": {
      "operations": [
        { "query": "UPDATE orders SET status = 'paid'" },
        { "query": "INSERT INTO log (action) VALUES ('order paid')" }
      ]
    }
  }
  

📚 Documentation

Common Issues and Troubleshooting

1. Service fails to start

• Cause: Incorrect configuration file or inability to connect to the database.
• Solution:
  • Check the database parameters in config.json for correctness.
  • Ensure that the database service is running and the network is reachable.

2. Unable to establish a connection in SSE mode

• Cause: The firewall blocks SSE communication, or the browser does not support the EventSource API.
• Solution:
  • Ensure that the target port is open and check the network connectivity.
  • Use the latest version of a modern browser to access the service.

3. Performance issues

• Cause: Improper connection pool configuration or low query efficiency.
• Solution:
  • Optimize the connection pool parameters, such as max_open_conns and max_idle_conns, based on the database performance.
  • Optimize SQL query statements to avoid full table scans.

4. Logging and debugging

• Log output: By default, the service outputs standard logs to the console. To enable file logging, refer to the documentation for configuration.
• Error troubleshooting: Check if the server port is occupied, view the specific error information, and resolve the problem.

More Resources

• Official Documentation
• Community Discussion
• Source Code Repository

If you encounter any issues or have suggestions for improvement, please feel free to create an issue on GitHub.