Dm MCP Server

🚀 DM Database MCP Service

This project is a Micro-service Communication Protocol (MCP) service based on DM Database, offering functionalities to streamline database interactions.

🚀 Quick Start

1. Environment Requirements

• Go Version: 1.16 or higher.
• DM Database: Installed and configured DM Database.
• Dependency Library: Ensure the github.com/mark3labs/mcp-go library is installed.

2. Install Dependencies

Run the following commands in the project root directory to initialize Go Modules and download dependencies:

go mod init dm-mcp-server
go mod tidy

3. Configure Database Connection

Before running the service, you need to configure the connection information for the DM Database. You can set it in the following ways:

• Command-line Arguments: Specify them via command-line arguments when starting the service.
• Environment Variables: Set them through environment variables.

Command-line Arguments

go run main.go \
  -username <username> \
  -password <password> \
  -host <host address> \
  -port <port> \
  -schema <schema name>

✨ Features

• List Tables in the Database: Use the list_tables tool to list all tables in the specified database.
• Execute Read-only SQL Queries: Use the execute_query tool to execute read-only SQL queries (only SELECT, SHOW, DESCRIBE, and EXPLAIN statements are supported).
• Display Table Structure: Use the describe_table tool to display the structure of the specified table.

📦 Installation

Install with go install

go install github.com/wangzhaobo168/dm-mcp-server

Configuration Example for DM MCP Server:

{
    "mcpServers": {
        "db-mcp-server": {
        "command": "dm-mcp-server",
        "args": [
        ],
        "env": {
            "DM_PORT": "Port number, default 5236",
            "DM_HOST": "Host address",
            "DM_USERNAME": "Username",
            "DM_PASSWORD": "Password",
            "DM_SCHEMA": "Schema name"
        }
    }
}

Check the dm-mcp-server Version:

dm-mcp-server --version

💻 Usage Examples

Basic Usage

On Windows, you can directly download the dm-mcp-server binary file and add it to the PATH.

📚 Documentation

Project Structure

dm-mcp-server/
├── main.go                # Main program entry
├── tools/                 # Tool implementation
│   ├── list_tables.go     # Table listing tool
│   ├── execute_query.go   # Query execution tool
│   └── describe_table.go  # Table structure display tool
├── utils/                 # Utility functions
│   ├── config.go          # Configuration management
│   └── db.go              # Database connection
├── go.mod                 # Go Modules file
└── README.md              # Project documentation

Contribution Guidelines

Welcome to submit Issues and Pull Requests to improve this project. Please ensure consistent code style and pass the tests.

Supplementary Instructions

⚠️ Important Note

If the github.com/mark3labs/mcp-go library is unavailable, please replace it with other compatible MCP implementations.

💡 Usage Tip

If you need to support more database operations, you can add new tools to the tools package.

📄 License

This project is licensed under the MIT License.