wenb1n-dev/SmartDB_MCP

SmartDB is a universal database gateway that implements the Model Context Protocol (MCP) server interface. This gateway allows MCP-compatible clients to connect and explore different databases.
Compared to similar products, SmartDB not only provides basic database connection and exploration capabilities but also adds advanced features such as OAuth 2.0 authentication , health checks, SQL optimization, and index health detection, making database management and maintenance more secure and intelligent.
Currently Supported Databases
| Database | Support | Description |
|------------|---------|--------------------------|
| MySQL | √ | Supports MySQL 5.6+, MariaDB 10+ |
| PostgreSQL | √ | Supports PostgreSQL 9.6+, YMatrix |
| Oracle | √ | Oracle 12+ |
| SQL Server | √ | Microsoft SQL Server 2012+ |
| Dameng | √ | Dameng 8.0+ |
Tool List
| Tool Name | Description |
|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| execute_sql | SQL execution tool that can execute ["SELECT", "SHOW", "DESCRIBE", "EXPLAIN", "INSERT", "UPDATE", "DELETE", "CREATE", "ALTER", "DROP", "TRUNCATE"] commands based on permission configuration |
| get_db_health | Analyzes database health status (connection status, transaction status, running status, lock detection) and outputs professional diagnostic reports and solutions |
| get_table_desc | Searches for table structures in the database based on table names, supports multi-table queries |
| get_table_index | Searches for table indexes in the database based on table names, supports multi-table queries |
| get_table_name | Database table name query tool. Used to query all table names in the database or search for corresponding table names based on Chinese table names or table descriptions |
| get_db_version | Database version query tool |
| sql_creator | SQL query generation tool that generates corresponding SQL query statements based on different database types |
| sql_optimize | A professional SQL performance optimization tool that provides expert optimization suggestions based on execution plans, table structure information, table data volume, and table indexes. |
Usage
Environment Configuration File Description
Note: If you adjust the client ID and key in the oauth configuration, please also modify the corresponding configuration in the static/config file in the previous code
Database Connection Configuration Description
* Database Connection Parameter Description
The following table details the meaning and usage of each parameter in the database connection configuration file:
| Parameter | Required | Type | Description |
|-----------|----------|------|-------------|
| host | Yes | string | Database server address |
| port | Yes | integer | Database server port number |
| user | Yes | string | Database username |
| password | Yes | string | Database user password |
| database | Yes | string | Database name to connect to |
| role | Yes | string | User role, such as "readonly" for read-only permissions |