Database MCP

🚀 Database MCP Service

A Meteor Control Protocol (MCP) service that supports multiple database types and provides database functionality through GORM.

🚀 Quick Start

The Database MCP Service is a powerful tool that integrates multiple database types and the MCP protocol. It offers flexible configuration options and is easy to set up and use.

✨ Features

• Multiple Database Support:
  • MySQL
  • PostgreSQL
  • SQLite
  • SQL Server
  • ClickHouse
• Configuration Methods:
  • Configuration file (YAML)
  • Command-line arguments
  • Environment variables
• MCP Protocol Integration
• GORM ORM Support

📦 Installation

1. Clone the repository.
2. Install dependencies:

   go mod tidy
   

📚 Documentation

Configuration File (config.yaml)

Create a config.yaml file with the following structure:

database:
  type: "mysql"  # mysql, postgres, sqlite, sqlserver, clickhouse
  host: "localhost"
  port: 3306
  username: "root"
  password: "password"
  database: "mydb"
  ssl_mode: "disable"  # for postgres
  file: "database.db"  # for sqlite

Command-line Arguments

You can override the settings in the configuration file via command-line arguments:

./database-mcp --config=config.yaml \
  --db-type=mysql \
  --db-host=localhost \
  --db-port=3306 \
  --db-user=root \
  --db-pass=password \
  --db-name=mydb \
  --db-ssl-mode=disable \
  --db-file=database.db

Available command-line arguments:

• --config: Path to the configuration file (default: "config.yaml")
• --db-type: Database type (mysql, postgres, sqlite, sqlserver, clickhouse)
• --db-host: Database host address
• --db-port: Database port
• --db-user: Database username
• --db-pass: Database password
• --db-name: Database name
• --db-ssl-mode: SSL mode (for PostgreSQL)
• --db-file: Database file path (for SQLite)

Usage Instructions

1. Start the service:

   ./database-mcp --db-type=mysql --db-host=127.0.0.1 --db-port=3306 --db-user=dbuser --db-pass=passwd --db-name=dbname --db-ssl-mode=disable --mode=http
   

2. Service Functions:
   • Load the configuration file and/or command-line arguments.
   • Initialize the database connection.
   • Start the MCP server.
   • Register available tools and resources.

MCP Configuration

To use the MCP service, configure the MCP endpoint in your MCP client:

http://127.0.0.1:8080/sse

This will connect your MCP client to the locally running service on port 8080.

MCP Tools

The service provides the following MCP tools:

1. get_tables: Get all tables in the database.
   • Return value: A list containing table names and remarks.
2. get_table_detail: Get detailed information about a specific table.
   • Parameters:
     • table_name: The name of the table to get detailed information about.
   • Return value: Information including table name, remarks, column information (field name, type, remarks, nullable, default value), etc.
3. execute_sql: Execute an SQL query.
   • Parameters:
     • query: The SQL query statement to execute.
   • Return value:
     • For SELECT queries: An array of result data.
     • For other queries (e.g., INSERT, UPDATE, DELETE): The number of affected rows.

📄 License

This project is licensed under the MIT License.