SmartDB

好用就帮忙点个赞，支持一下呀，拜托各位精英们～。

SmartDB是一个通用数据库网关，实现了模型上下文协议（Model Context Protocol，简称MCP）服务器接口。这个网关允许与MCP兼容的客户端连接并探索不同的数据库。

与同类产品相比，SmartDB不仅提供基本的数据库连接和探索功能，还增加了OAuth2.0认证、健康检查、SQL优化和索引健康检测等高级功能，使数据库管理和维护更加安全、智能化。

目前支持的数据库

工具列表

使用方法

env 配置文件说明

bash
#数据库配置文件路径
DATABASE_CONFIG_FILE=/Volumes/SmartDB/src/config/database_config.json

#========OAuth2========
#OAuth2 客户端 ID
CLIENT_ID=smart_db_client_id
#OAuth2 客户端密钥
CLIENT_SECRET=smart_db_client_secret
#访问令牌过期时间（分钟）
ACCESS_TOKEN_EXPIRE_MINUTES=30
#刷新令牌过期时间（天）
REFRESH_TOKEN_EXPIRE_DAYS=30
#令牌加密密钥
TOKEN_SECRET_KEY=smart_db_token_secret
#用户名
OAUTH_USER_NAME=admin
#密码
OAUTH_USER_PASSWORD=wenb1n## 数据库连接配置说明
json
{
"default": {
"host": "192.168.xxx.xxx",
"port": 3306,
"user": "root",
"password": "root",
"database": "a_llm",
"role": "readonly",
"pool_size": 10,
"max_overflow": 20,
"pool_recycle": 3600,
"pool_timeout": 30,
"type": "mysql"
},
"postgresql": {
"host": "192.168.xxx.xxx",
"port": 5432,
"user": "postgres",
"password": "123456",
"database": "postgres",
"schema": "public",
"role": "readonly",
"pool_size": 5,
"max_overflow": 10,
"pool_recycle": 3600,
"pool_timeout": 30,
"type": "postgresql"
},
"oracle": {
"host": "192.168.xxx.xxx",
"port": 1521,
"user": "U_ORACLE",
"password": "123456",
"database": "123456",
"service_name": "ORCL",
"role": "readonly",
"pool_size": 5,
"max_overflow": 10,
"pool_recycle": 3600,
"pool_timeout": 30,
"type": "oracle"
},
"mssql": {
"host": "192.168.xxx.xxx",
"port": 1433,
"user": "test",
"password": "123456",
"database": "TEST",
"schema": "dbo",
"role": "readonly",
"pool_size": 5,
"max_overflow": 10,
"pool_recycle": 3600,
"pool_timeout": 30,
"type": "mssqlserver"
}
}

• 数据库连接参数说明

下表详细说明了数据库连接配置文件中各参数的含义和用法：

• 特定数据库额外参数

• role 权限控制配置项以及对应数据库权限：只读（readonly）、读写（writer）、管理员（admin）
  bash
  "readonly": ["SELECT", "SHOW", "DESCRIBE", "EXPLAIN"], # 只读权限
  "writer": ["SELECT", "SHOW", "DESCRIBE", "EXPLAIN", "INSERT", "UPDATE", "DELETE"], # 读写权限
  "admin": ["SELECT", "SHOW", "DESCRIBE", "EXPLAIN", "INSERT", "UPDATE", "DELETE",
  "CREATE", "ALTER", "DROP", "TRUNCATE"] # 管理员权限

• 注意

default 为默认数据库连接配置，必须配置，其他数据库配置请自行添加

pip安装和配置

1. 安装包
   bash
   pip install SmartDB-MCP

参数说明
--mode：传输模式（“stdio”，“sse”，“streamablehttp”）
--envfile 环境变量文件路径
--oauth 启用 oauth 认证（目前仅支持“streamablehttp”模式）

启动命令：
smartdb --envfile=/Volumes/config/.env --oauth=true

docker 启动

快速开始

1. 构建并启动服务

bash
#使用docker-compose启动服务
docker-compose up -d

#查看服务状态
docker-compose ps

#查看日志
docker-compose logs -f smartdb

2. 手动构建镜像

bash
#构建镜像
docker build -t smartdb-mcp:latest .

#运行容器
docker run -d
--name smartdb-mcp-server
-p 3000:3000
-e DATABASE_CONFIG_FILE=/app/src/config/database_config.json
-e CLIENT_ID=smart_db_client_id
-e CLIENT_SECRET=smart_db_client_secret
-e TOKEN_SECRET_KEY=your_secret_key
-v $(pwd)/src/config:/app/src/config:ro
-v $(pwd)/logs:/app/logs
smartdb-mcp:latest

注意：若调整了oauth配置中客户端的id以及密钥，请同时修改前端代码中static/config文件中的对应配置。## 代码启动

本地开发 Streamable Http 方式

• 使用 uv 启动服务

将以下内容添加到你的 mcp client 工具中，例如 cursor、cline 等

mcp json 如下
json
{
"mcpServers": {
"smartdb": {
"name": "smartdb",
"type": "streamableHttp",
"description": "",
"isActive": true,
"url": "http://localhost:3000/mcp/"
}
}
}

启动命令
bash

下载依赖

uv sync

启动

uv run -m core.server

自定义env文件位置

uv run -m core.server --envfile /path/to/.env

本地开发 SSE 方式

• 使用 uv 启动服务

将以下内容添加到你的 mcp client 工具中，例如 cursor、cline 等

mcp json 如下
json
{
"mcpServers": {
"smartdb": {
"name": "smartdb",
"description": "",
"isActive": true,
"url": "http://localhost:3000/sse"
}
}
}

启动命令
bash

下载依赖

uv sync

启动

uv run -m mysql_mcp_server_pro.server --mode sse

自定义env文件位置

uv run -m mysql_mcp_server_pro.server --mode sse --envfile /path/to/.env

本地开发 STDIO 方式

将以下内容添加到你的 mcp client 工具中，例如 cursor、cline 等

mcp json 如下
json
{
"mcpServers": {
"smartdb": {
"name": "smartdb",
"type": "stdio",
"isActive": false,
"registryUrl": "",
"command": "uv",
"args": [
"--directory",
"/Volumes/python/SmartDB/",
"run",
"-m",
"core.server",
"--mode",
"stdio"
],
"env": {
"DATABASE_CONFIG_FILE": "/Volumes/database_config.json"
}
}
}
}
}

支持OAuth 2.0 认证

1. 启动认证服务,默认使用自带的OAuth 2.0 密码模式认证，可以在 env 中修改自己的认证服务地址
   bash
   uv run -m core.server --oauth=true

2. 访问 认证服务 http://localhost:3000/login ，默认帐号密码在 env 中配置
   

3. 复制 token ，将token 添加在请求头中，例如
   

json
{
"mcpServers": {
"smartdb": {
"name": "smartdb",
"type": "streamableHttp",
"description": "",
"isActive": true,
"url": "http://localhost:3000/mcp/",
"headers": {
"authorization": "bearer TOKEN值"
}
}
}
}

使用示例

1. 查询 default 连接池的表数据
   

2. 查询其他连接池的表数据
   

3. 查询其他连接池、其他库的表数据
   

4. 修改表数据
   

5. 数据库健康检测
   

6. SQL 优化