atengk-mcp-server-rdbms

通用的关系型数据库模型上下文协议（Model Context Protocol, MCP）官方服务，基于 Python 3.12+、SQLAlchemy 2.0 与 FastMCP 现代化架构构建。专为各类大语言模型（LLM）与智能体（Claude、Cursor、Windsurf、Dify 等）提供标准、安全、可控、高内聚的多数据库探查、查询采样、慢查询诊断与原子事务变更能力。

---

🌟 核心特性与架构底座

🏗️ 系统全景架构拓扑 (Architecture Topology)

flowchart TD
    subgraph ClientSide ["AI 客户端生态 (MCP Client)"]
        Client["Claude Desktop / Cursor / VS Code / Dify / Windsurf"]
    end

    subgraph ProtocolLayer ["通信传输与分层环境层"]
        FastMCP["FastMCP 协议服务器 (stdio / sse)"]
        Env["分层环境解析器 (core/env.py)"]
        Dotenv[".env 自动探测与 RFC 1738 密码免转义拼装"]
    end

    subgraph GuardLayer ["AST 深度语法安全守卫 (core/guard.py)"]
        ASTParse["sqlglot AST 语法树解析与分析"]
        ReadOnly["只读语义校验 (Select / CTE With)"]
        LimitInject["自动注入安全 LIMIT 截断 (默认 100 行)"]
        WhereGuard["DML 强制阻断无 WHERE 条件的 UPDATE/DELETE"]
        ExplainGuard["sql_explain 危险修饰符 (ANALYZE) 拦截与剥离"]
    end

    subgraph EngineLayer ["连接池与多库路由中枢 (core/connection.py)"]
        Registry["ConnectionRegistry (多库配置中心)"]
        Pool["连接池健康预检与自愈 (pool_pre_ping)"]
        Audit["独立审计流水日志 (rdbms_mcp_audit.log)"]
    end

    subgraph DatabaseLayer ["多元关系型数据库集群 (SQLAlchemy 2.0)"]
        MySQL[("MySQL 8.x / 5.7 / MariaDB")]
        PostgreSQL[("PostgreSQL 12~17")]
        SQLite[("SQLite 内存库 / 本地文件库")]
        Oracle[("Oracle 19c / 21c")]
        MSSQL[("SQL Server / ClickHouse / 国产库")]
    end

    Client -->|"JSON-RPC (stdio / sse)"| FastMCP
    Dotenv --> Env --> Registry
    FastMCP -->|"9 核心工具调用"| GuardLayer
    GuardLayer -->|"AST 验证通过"| Registry
    Registry --> Pool
    Pool -->|"工作线程池异步卸载 (anyio)"| DatabaseLayer
    Registry -.->|"写操作流水异步落盘"| Audit

• 🚀 通用多数据库抽象底座：
  • 基于 SQLAlchemy 2.0 驱动引擎，默认内置 SQLite、PostgreSQL (psycopg3)、MySQL (pymysql)；
  • 插件化扩展无缝支持 Oracle、SQL Server、ClickHouse 及各类符合标准方言的国产数据库（达梦、人大金仓等）。
• 🛡️ AST 语法树级深度安全守卫 (Guardrail)：
  • 基于 sqlglot 语法树静态分析，只读模式下物理拦截任何多语句拼接（SQL 注入防御）以及非 SELECT/WITH 写入操作；
  • 自动 LIMIT 注入：为未指定行数的大模型查询强制追加安全截断（默认 100 行），彻底杜绝全表拉取导致 OOM 或上下文爆炸；
  • 灾难性误改误删阻断：静态分析强制拦截缺少 WHERE 条件的 UPDATE 与 DELETE 语句，直接驳回。
• ⚡ 原子事务与权限双重门禁：
  • sql_dml 接受单条或批量 SQL，底层在单一原子事务块中执行，任何单步失败全量自动 ROLLBACK，绝不留脏数据；
  • 默认强只读保护，写权限必须通过 --allow-dml 与 --allow-ddl 显式授权，且 DDL 建表/删表要求 confirm=True 二次确认。
• 🌐 多数据库配置中心与连接池自愈：
  • 支持单库环境变量/CLI 直连，亦支持通过 YAML/JSON 配置文件声明多库路由；
  • 连接池集成 pool_pre_ping=True 探针预检与周期回收，毫秒级自愈因外部超时、防火墙丢包或数据库重启导致的死连接。
• 🔍 精炼 9 核心工具矩阵：无二义性、零冗余设计，工具严格按领域命名空间规范组织，模型理解与调用准确率极高。
• 📝 变更操作独立审计流水：所有 DDL 与 DML 操作均异步落盘记录至本地 rdbms_mcp_audit.log，包含时间戳、执行 SQL、影响行数与耗时。

---

🛠️ 9 核心工具矩阵全景契约

所有工具均支持可选的 db 参数。不传时自动路由到默认连接；传入时精确定位目标多库别名：

领域前缀	工具名称	参数契约	功能描述与安全约束
db_	db_list_connections	()	查看所有已配置连接别名、方言内核、默认库标识与只读保护状态。密码强制执行 *** 安全脱敏掩码
	db_get_info	(db: str = None)	探查目标数据库内核方言、真实版本号、当前 Schema/Database 及活跃登录用户
schema_	schema_list_tables	(schema=None, include_views=False, db=None)	获取业务数据表与视图清单、表注释并自动聚合全库外键依赖拓扑。自动过滤数据库系统保留模式
	schema_describe_table	(table_name: str, schema=None, db=None)	一站式全息探查数据表列明细（类型、可空性、默认值）、主键约束、外键关联与全部索引明细
sql_	sql_query	(sql: str, limit: int = 100, format="json", db=None)	安全只读数据采样与业务分析，支持复杂 CTE WITH 语法。支持 json / markdown / csv 格式，自动序列化 Decimal/时间/BLOB 并自动注入 LIMIT
	sql_explain	(sql: str, db=None)	执行 EXPLAIN 获取数据库原生查询执行计划，辅助分析慢查询与索引命中瓶颈
	sql_dml	(sql: str | list[str], db=None)	原子事务数据增删改（支持单条或批量）。单步失败全量自动回滚，受 --allow-dml 门禁管控，强制拦截无 WHERE 条件操作
	sql_ddl	(sql: str, confirm: bool = False, db=None)	结构定义变更（建表、删表、改表）。受 --allow-ddl 权限管控并要求 confirm=True 二次确认
admin_	admin_list_running_queries	(db=None)	观测数据库正在运行的长查询与活动会话（针对 SQLite 等轻量库自适应优雅降级）

---

📦 快速安装与运行

推荐使用现代化 Python 工具 uv / uvx，无需在本地手动克隆代码或配置 Python 虚拟环境，一行命令即可秒级启动：

# 1. 单数据库直连启动 (只读安全模式)
uvx atengk-mcp-server-rdbms --db-url "postgresql+psycopg://user:password@localhost:5432/mydb"

# 2. 多数据库配置文件启动
uvx atengk-mcp-server-rdbms --config ./connections.yaml

# 3. 开启写入权限 (允许 DML 与 DDL)
uvx atengk-mcp-server-rdbms --db-url "sqlite:///./demo.db" --allow-dml --allow-ddl

若需从本地源码运行：

git clone https://github.com/atengk/mcp-server-rdbms.git
cd mcp-server-rdbms
uv sync
uv run atengk-mcp-server-rdbms --db-url "sqlite:///./demo.db"

---

🔌 MCP 客户端通用标准配置

💡 提示：以下配置完全遵循 Model Context Protocol (MCP) 官方开放规范，适用于 Claude Desktop、Cursor、Windsurf、VS Code 以及任何兼容 MCP 协议的 AI 客户端。

场景 1：标准本地调用 (stdio 协议，推荐)

在您所使用客户端的 MCP 配置文件（如 mcp.json 或 claude_desktop_config.json）的 "mcpServers" 块中添加。支持环境变量注入与命令行参数两种等价范式：

模式 A-1：原子字段模式（🔥 强烈推荐 ⭐⭐⭐⭐⭐，密码特殊字符免手动转义！）

针对密码包含 @、#、: 等特殊字符的情况，直接填写明文密码即可！服务内置环境自动拼装器会自动进行 RFC 1738 安全转义，再也无需手工查表编码！

{
  "mcpServers": {
    "rdbms": {
      "command": "uvx",
      "args": ["atengk-mcp-server-rdbms"],
      "env": {
        "MCP_RDBMS_DIALECT": "mysql",
        "MCP_RDBMS_DB_HOST": "127.0.0.1",
        "MCP_RDBMS_DB_PORT": "3306",
        "MCP_RDBMS_USER": "root",
        "MCP_RDBMS_PASSWORD": "Admin@123#2026",
        "MCP_RDBMS_DATABASE": "mydb"
      }
    }
  }
}

模式 A-2：全量连接串环境变量模式

{
  "mcpServers": {
    "rdbms": {
      "command": "uvx",
      "args": ["atengk-mcp-server-rdbms"],
      "env": {
        "MCP_RDBMS_DB_URL": "postgresql+psycopg://user:password@localhost:5432/mydb"
      }
    }
  }
}

模式 B：命令行参数直连模式

{
  "mcpServers": {
    "rdbms": {
      "command": "uvx",
      "args": [
        "atengk-mcp-server-rdbms",
        "--db-url",
        "mysql+pymysql://root:Admin%40123@127.0.0.1:3306/mydb?charset=utf8mb4"
      ]
    }
  }
}

模式 C：多数据库配置中心模式

{
  "mcpServers": {
    "rdbms": {
      "command": "uvx",
      "args": ["atengk-mcp-server-rdbms"],
      "env": {
        "MCP_RDBMS_CONFIG": "/path/to/connections.yaml",
        "MCP_RDBMS_ALLOW_DML": "true",
        "MCP_RDBMS_ALLOW_DDL": "true"
      }
    }
  }
}

---

🌐 环境变量完整速查矩阵 (12-Factor App)

服务提供官方推荐前缀 MCP_RDBMS_* 与通用标准环境变量双重支持：

分类	推荐主环境变量	宽容兼容变量	默认值 / 行为说明
完整连接	MCP_RDBMS_DB_URL	DATABASE_URL	完整 RFC 1738 连接串（如 sqlite:///:memory:）
多库配置	MCP_RDBMS_CONFIG	CONFIG_FILE	多数据源 YAML 配置文件绝对路径
数据库方言	MCP_RDBMS_DIALECT	DB_DIALECT	数据库类型（mysql, postgresql, oracle, mssql, sqlite 等）
主机地址	MCP_RDBMS_DB_HOST	DB_HOST	数据库主机 IP 或域名（默认: 127.0.0.1）
端口	MCP_RDBMS_DB_PORT	DB_PORT	数据库端口（缺省按方言自适应推导，如 MySQL 3306, PG 5432）
用户名	MCP_RDBMS_USER	DB_USER / DB_USERNAME	数据库登录用户
密码	MCP_RDBMS_PASSWORD	DB_PASSWORD / DB_PASS	明文自动 URL 安全编码（如 @ -> %40，彻底防踩坑）
数据库名称	MCP_RDBMS_DATABASE	DB_NAME / DB_DATABASE	目标数据库/Schema 库名
附加参数	MCP_RDBMS_PARAMS	DB_PARAMS	连接查询参数（如 charset=utf8mb4）
增删改权限	MCP_RDBMS_ALLOW_DML	MCP_ALLOW_DML	宽容布尔值（1, true, yes, on, t 大小写不敏感）
表结构变更	MCP_RDBMS_ALLOW_DDL	MCP_ALLOW_DDL	宽容布尔值（1, true, yes, on, t 大小写不敏感）
通信传输协议	MCP_RDBMS_TRANSPORT	MCP_TRANSPORT	stdio（默认）、sse、streamable-http
服务监听地址	MCP_RDBMS_SERVER_HOST	HOST	SSE/HTTP 监听地址（默认: 127.0.0.1）
服务监听端口	MCP_RDBMS_SERVER_PORT	PORT	SSE/HTTP 监听端口（默认: 8000）

📌 解析优先级规则：命令行参数 (最高) > 全量 URL 环境变量 > 独立字段环境变量拼装 > 标准内置默认值。本地执行时会自动探测读取同级目录下的 .env 文件。

---

场景 2：远程服务调用 (SSE 协议客户端接入)

若服务已部署在局域网、云服务器或容器中，客户端可直接通过标准 HTTP SSE 端点接入：

{
  "mcpServers": {
    "rdbms-remote": {
      "url": "http://<服务器IP>:8000/sse"
    }
  }
}

---

🐳 生产环境容器化常驻部署 (Docker & Docker Compose)

针对内网私有云、NAS（群晖/威联通）或 Linux 服务器，项目提供官方生产级 Dockerfile 与 docker-compose.yaml，支持 100% 环境变量无参启动。

1. 使用 Docker Compose 一键拉起（推荐 ⭐⭐⭐⭐⭐）

在项目根目录下准备好 connections.yaml（或 .env），直接启动常驻守护容器：

# 启动常驻服务
docker compose up -d

# 查看运行日志与连接池状态
docker compose logs -f

# 停止服务
docker compose down

docker-compose.yaml 核心配置解析：

services:
  mcp-rdbms:
    build: .
    image: atengk-mcp-server-rdbms:1.1.0
    container_name: mcp-server-rdbms
    restart: unless-stopped
    ports:
      - "8000:8000"
    environment:
      - MCP_RDBMS_TRANSPORT=sse
      - MCP_RDBMS_SERVER_HOST=0.0.0.0
      - MCP_RDBMS_SERVER_PORT=8000
      - MCP_RDBMS_CONFIG=/app/connections.yaml
    volumes:
      # 挂载多库配置（只读）
      - ./connections.yaml:/app/connections.yaml:ro
      # 挂载操作审计流水日志（宿主机持久化保存）
      - ./rdbms_mcp_audit.log:/app/rdbms_mcp_audit.log:rw

2. 使用 Docker CLI 独立运行

亦可直接使用标准 docker run 命令启动：

# 方式 A：挂载本地 connections.yaml 多库配置启动
docker run -d \
  --name mcp-rdbms \
  -p 8000:8000 \
  -v $(pwd)/connections.yaml:/app/connections.yaml:ro \
  -v $(pwd)/rdbms_mcp_audit.log:/app/rdbms_mcp_audit.log:rw \
  -e MCP_RDBMS_CONFIG=/app/connections.yaml \
  ghcr.io/atengk/mcp-server-rdbms:latest

# 方式 B：纯环境变量直连单数据库（免挂载任何文件，密码特殊字符自动免转义！）
docker run -d \
  --name mcp-rdbms \
  -p 8000:8000 \
  -e MCP_RDBMS_DIALECT=mysql \
  -e MCP_RDBMS_DB_HOST=192.168.1.100 \
  -e MCP_RDBMS_DB_PORT=3306 \
  -e MCP_RDBMS_USER=root \
  -e MCP_RDBMS_PASSWORD="Admin@123#2026" \
  -e MCP_RDBMS_DATABASE=mydb \
  ghcr.io/atengk/mcp-server-rdbms:latest

---

🌐 数据库连接串速查表与特殊字符转义避坑指南

SQLAlchemy 底层解析数据库连接串时采用标准 RFC 1738 URL 规范。当密码中包含特殊字符时，如果不进行 URL 编码，解析器会将特殊字符误当作分隔符导致连接崩溃。

1. 常见数据库标准连接串速查表

数据库类型	标准 Driver Scheme	连接串格式示例
SQLite (文件库)	sqlite	sqlite:///./my_database.db（相对路径）或 sqlite:////data/db.sqlite（绝对路径）
SQLite (内存库)	sqlite	sqlite:///:memory:
PostgreSQL	postgresql+psycopg	postgresql+psycopg://user:password@127.0.0.1:5432/mydb?sslmode=prefer
MySQL 8.x / 5.7	mysql+pymysql	mysql+pymysql://user:password@127.0.0.1:3306/mydb?charset=utf8mb4
Oracle 19c / 21c	oracle+oracledb	oracle+oracledb://scott:tiger@192.168.1.10:1521/?service_name=orcl
SQL Server	mssql+pyodbc	mssql+pyodbc://sa:password@192.168.1.20:1433/mydb?driver=ODBC+Driver+18+for+SQL+Server&TrustServerCertificate=yes
ClickHouse	clickhouse+connect	clickhouse+connect://default:password@127.0.0.1:8123/default

2. ⚠️ 核心避坑：密码特殊字符转义规则对照表

若您的密码中含有 @、:、/、# 等字符，请务必在连接串中转换为下表的 URL 编码：

特殊字符	误用场景痛点	必须转义为 (URL Encode)	示例 (原始密码 -> 转义后连接串)
@	会被误判定为主机名分隔符导致截断	%40	Admin@123 -> user:Admin%40123@host:3306/db
:	会被误判定为端口分隔符	%3A	Pass:123 -> user:Pass%3A123@host:3306/db
/	会被误判定为路径数据库名分隔符	%2F	P/ssword -> user:P%2Fssword@host:3306/db
#	会被误判定为 URL Hash 片段截断参数	%23	Pass#2024 -> user:Pass%232024@host:3306/db
%	URL 编码引导符自身	%25	P%ss -> user:P%25ss@host:3306/db

💡 快速编码小妙招：在终端执行 Python 单行命令即可安全获取转义密码：

python -c "from urllib.parse import quote_plus; print(quote_plus('Admin@123#2026'))"
# 输出: Admin%40123%232026

🚀 终极省心方案：若使用上述 原子字段环境变量模式（如 MCP_RDBMS_PASSWORD），直接填入原始密码明文即可，服务启动时将自动完成 URL 安全编码，彻底避免因遗漏转义导致的崩溃！

---

📑 多数据库配置中心 connections.yaml 深度指南

当需要同时管理多个数据库时，可在本地创建 connections.yaml 文件（可参考根目录下提供的模板 connections.example.yaml）：

# 默认连接别名 (调用工具未传 db 参数时默认使用的连接)
default: "pg_main"

connections:
  # 1. 核心业务主库 (支持读写模式与事务)
  pg_main:
    url: "postgresql+psycopg://postgres:Admin%40123@10.0.0.1:5432/business_db"
    read_only: false       # 设为 false 配合 --allow-dml 允许修改
    is_default: true

  # 2. 只读离线数据仓库 (强制只读保护)
  mysql_analytics:
    url: "mysql+pymysql://reader:Public%40123@10.0.0.2:3306/dw_db?charset=utf8mb4"
    read_only: true        # 该连接强制只读，即使传入 --allow-dml 也禁止修改

  # 3. 本地嵌入式开发数据库
  sqlite_local:
    url: "sqlite:///./dev_cache.db"
    read_only: false

启动命令：

uvx atengk-mcp-server-rdbms --config ./connections.yaml --allow-dml

在大模型会话中，大模型可通过如下方式智能调度不同库：

• “查看默认库的所有表结构” -> 自动路由至 pg_main；
• “在 mysql_analytics 库上分析上周活跃用户数” -> 工具调用参数 db="mysql_analytics"。

---

🧩 扩展方言驱动支持与 --with 挂载

本服务默认内置了 SQLite、PostgreSQL、MySQL 驱动。若需连接 Oracle、SQL Server、ClickHouse 等其他数据库，推荐使用 uvx 的 --with 参数动态挂载，无需重新打包：

# 挂载 Oracle 驱动
uvx --with oracledb atengk-mcp-server-rdbms --db-url "oracle+oracledb://scott:tiger@host:1521/?service_name=orcl"

# 挂载 SQL Server 驱动
uvx --with pyodbc atengk-mcp-server-rdbms --db-url "mssql+pyodbc://sa:pass@host:1433/db?driver=ODBC+Driver+18+for+SQL+Server"

# 挂载 ClickHouse 驱动
uvx --with clickhouse-connect atengk-mcp-server-rdbms --db-url "clickhouse+connect://default:pass@host:8123/default"

若使用 pip 安装至现有虚拟环境，可安装对应的 extras 依赖包：

uv pip install "atengk-mcp-server-rdbms[oracle]"      # 安装 Oracle 支持
uv pip install "atengk-mcp-server-rdbms[mssql]"       # 安装 SQL Server 支持
uv pip install "atengk-mcp-server-rdbms[clickhouse]"  # 安装 ClickHouse 支持
uv pip install "atengk-mcp-server-rdbms[all]"         # 一键安装所有驱动扩展

---

💻 完整 CLI 启动参数参考表

用法: atengk-mcp-server-rdbms [-h] [--db-url DB_URL] [--config CONFIG] [--allow-dml]
                              [--allow-ddl] [--transport {stdio,sse,streamable-http}]
                              [--host HOST] [--port PORT]

参数选项	类型	环境变量等价项	默认值	功能详细说明
--db-url	str	DATABASE_URL	None	单数据库连接串 URL，优先级高于环境变量
--config	str	MCP_RDBMS_CONFIG	None	多数据库 YAML 或 JSON 配置文件路径
--allow-dml	flag	-	False	显式开启数据增删改（DML）权限门禁
--allow-ddl	flag	-	False	显式开启结构变更（DDL）权限门禁
--transport	str	-	stdio	客户端通信协议，支持 stdio、sse、streamable-http
--host	str	-	127.0.0.1	SSE 或 HTTP 服务的绑定监听地址
--port	int	-	8000	SSE 或 HTTP 服务的监听端口

---

🔒 生产级安全建议与合规审计

1. 默认强只读原则：在生产环境中，如无明确数据修改需求，请勿传入 --allow-dml 与 --allow-ddl。默认模式下即使大模型生成恶意 SQL，也会在 AST 语法分析阶段被物理拦截；
2. 连接密码脱敏保证：大模型调用 db_list_connections 探查网络拓扑时，所有连接凭据均强制替换为 ***，杜绝大模型在上下文回显或外部泄露凭据；
3. 审计追溯 (rdbms_mcp_audit.log)：服务自动在运行目录下生成并维护 rdbms_mcp_audit.log 审计流水文件，每一行均以格式化 JSON 记录操作状态：

   {"timestamp":"2026-10-04T08:30:00Z","operation":"sql_dml","db":"pg_main","statements":["UPDATE users SET status = 1 WHERE id = 100"],"status":"SUCCESS","rows_affected":1,"duration_ms":12.5,"error":null}
   

---

🤝 参与贡献

欢迎任何形式的贡献、Issue 反馈与功能提案！请在发起 PR 前仔细阅读我们的 贡献指南 (CONTRIBUTING.md)。

---

📄 开源许可证

本项目基于 MIT 许可证 开源。欢迎社区开发者提出 Issue、构建各类专用数据库插件与贡献代码！