AgentSQL
Protects MySQL 8 business databases as a gateway target, applying the same identity, AST-level authorization, dangerous-statement blocking, row/result limits, masking and audit pipeline to agent-issued SQL.
Protects PostgreSQL 14–18 business databases as the gateway's target: every agent-issued query is authenticated, SQL-parsed into an AST, authorized/rule-evaluated, executed under limits, result-masked and audited. Also supports PostgreSQL 15+ (PG18 baseline) as the control plane for metadata and audit storage, including separate metadata/audit databases and migration from SQLite.
Exposes Prometheus metrics alongside health and readiness probes so gateway operations, decisions and query activity can be scraped and monitored.
Default zero-configuration control plane backend, storing AgentSQL metadata and audit records in a single combined SQLite database (e.g. /var/lib/agentsql/agentsql.db), with the ability to migrate that data to PostgreSQL later.
AgentSQL
AgentSQL(中文品牌名:智盾,控制台显示为「AgentSQL 智盾控制台」)是面向 AI Agent 的数据库安全网关与生产级 MCP Server:让模型发出的每条 PostgreSQL/MySQL 请求在到达数据库前,经过身份认证、SQL 解析、授权与规则评估、受控执行、结果脱敏和审计。
AI Agent → LLM / MCP Client → AgentSQL 网关 → PostgreSQL / MySQL
│
└─ 鉴权 · 授权 · 规则 · 审批 · 脱敏 · 审计核心特性
双 MCP 承载:本机
stdio与 Streamable HTTP/mcp,提供 7 个受控数据库工具。默认拒绝的安全链路:API Key 认证、Agent 能力档位、对象/列授权、SQL AST 规则与 fail-closed 错误处理。
受控读写:只读保护、危险 SQL 拦截、Explain 风险评估、超时、连接/QPS/结果行数限制和人工审批。
基础数据保护:列级脱敏提供四种算法——六类
mask部分遮蔽、九类均可用的带专用密钥 HMAChash指纹、无需密钥且把非空值统一替换为***的block整值阻断,以及仅用于number/date、通过数值分桶或日期截断保留粗粒度分布且无需密钥的range。数据源口令另由 32 字节AGENTSQL_SECRET加密保存。可追溯运维:默认零配置 SQLite;可选 PostgreSQL 15+ 控制面(PostgreSQL 18 为基准,metadata 与 audit 可分库);支持审计导出(面向机器的 JSONL,以及 Excel/WPS 可直接打开、带公式注入防护的中文 CSV)、审批决策闭环、Prometheus 指标与健康/就绪探针。
安全事件通知:按决策过滤并以 Webhook 或 Syslog 旁路外发;默认关闭、默认不含 SQL,通知失败不影响审计与 SQL 决策。
内嵌 Web 控制台:总览、审计、演示台、Agent、数据源、权限、规则、审批和脱敏规则管理。
Related MCP server: PostgreSQL MCP Server
5 分钟快速开始
以下三条路径都默认只在宿主机回环地址监听。自动安装器生成的是持久使用的管理员密码,不是一次性口令;远程访问请使用 SSH 本地转发,例如 ssh -L 7780:127.0.0.1:7780 user@server,不要直接向公网暴露 7780。
1. Linux 裸机一行安装(推荐)
v0.4.0 起提供 linux/amd64 与 linux/arm64 两种原生 glibc 包:uname -m 为 x86_64 / amd64 时使用 amd64 包,为 aarch64 / arm64 时使用 arm64 包。两者均要求 glibc 2.28+ 且 systemd 为 PID 1;安装器会自动选择本机架构、校验发布包外层与包内哈希,并安装为 systemd 服务。musl / Alpine 与 CentOS 7 仍不支持:
curl -fsSL https://github.com/cuipengdba/agentsql/releases/latest/download/install.sh | sudo sh -s -- install管道和 CI 的非 TTY 输出不会显示自动生成的管理员密码;root 可在 /etc/agentsql/agentsql.env 查看。交互终端会在首次创建凭据时显示一次,也可显式加 --show-password。离线环境同时取得 tarball 与同名 .sha256 后,校验、解压并从包根安装:
以下是既有 amd64 资产示例;v0.4.0 起 arm64 主机使用同版本的 -linux-arm64 资产名。
sha256sum -c agentsql-v0.4.0-linux-amd64.tar.gz.sha256
tar -xzf agentsql-v0.4.0-linux-amd64.tar.gz
cd agentsql-v0.4.0-linux-amd64
sudo ./install.sh install2. Docker 一行启动
脚本默认拉取 GitHub 最新稳定 Release 对应的精确 GHCR tag;该 tag 是 linux/amd64 + linux/arm64 多架构镜像,Docker 会自动匹配运行架构。脚本生成权限为 0600 的 .env,使用 agentsql-data 命名卷,并固定绑定回环地址:
curl -fsSL https://raw.githubusercontent.com/cuipengdba/agentsql/main/scripts/quickstart.sh -o quickstart.sh && sh quickstart.shGHCR 包必须由发布者设为 public,以上命令才能在未登录环境匿名拉取。也可先用一条命令拉取,Docker 会从 manifest list 自动选择 linux/amd64 或 linux/arm64:
docker pull ghcr.io/cuipengdba/agentsql:v0.4.0等价的单条 docker run 如下;随机值只通过当前 shell 环境传入,不写进命令行参数:
export AGENTSQL_SECRET="$(openssl rand -base64 24)" AGENTSQL_ADMIN_USER=admin AGENTSQL_ADMIN_PASSWORD="$(openssl rand -base64 18)"
docker run -d --name agentsql --restart unless-stopped --security-opt no-new-privileges:true -p 127.0.0.1:7780:7780 -e AGENTSQL_SECRET -e AGENTSQL_ADMIN_USER -e AGENTSQL_ADMIN_PASSWORD -v agentsql-data:/var/lib/agentsql ghcr.io/cuipengdba/agentsql:v0.4.03. 本地 Live Demo(一条命令,无需源码)
这套自包含环境只连接合成的 PostgreSQL/MySQL 演示数据,不连接真实数据库。无需克隆源码、无需编辑配置或构建镜像,只需下载一个 compose 文件并启动:
mkdir agentsql-demo && cd agentsql-demo
curl -fsSL -o docker-compose.yml https://raw.githubusercontent.com/cuipengdba/agentsql/main/deploy/quickstart/docker-compose.yml
docker compose up -d等待约 1–2 分钟,四个容器就绪后打开 http://127.0.0.1:17880:登录页已自动填好演示账号,直接点「登录」即可。「演示台」内置 5 个真实剧本:列授权 + 脱敏、列授权缺失、对象越权、DDL 越权、写操作转人工。彻底清理:
docker compose down -vDemo 凭据均为固定演示值、写在 compose 中,仅用于本地体验,切勿连接真实数据。完整说明见 5 分钟快速上手 与 Live Demo 指南。
其他安装方式(源码构建、离线与审计环境)
需要审计每一步、修改 Compose 配置或从源码构建时,可继续使用原有流程。Docker Compose 默认只启动 AgentSQL,元数据和审计写入命名卷 agentsql-data 中的 /var/lib/agentsql/agentsql.db:
cp examples/docker/.env.example .env
openssl rand -base64 24 # 填入 AGENTSQL_SECRET,输出恰好 32 个 ASCII 字节
openssl rand -base64 24 # 填入 AGENTSQL_ADMIN_PASSWORD
docker compose up -d --build
docker compose psPowerShell 可分别执行两次以下命令并填写两个变量:
$bytes = [byte[]]::new(24); $rng = [System.Security.Cryptography.RandomNumberGenerator]::Create(); $rng.GetBytes($bytes); [Convert]::ToBase64String($bytes); $rng.Dispose()访问 http://127.0.0.1:7780。Compose 也只在宿主机回环地址暴露端口。需要可观测性栈时,先在环境中设置自行生成并保存的随机值,再运行:
docker compose --profile observability up -d --build完整说明见 可观测性示例。AGENTSQL_SECRET 必须与 agentsql.db 成对备份;直接更换 SECRET 会让既有数据源口令无法解密。生产控制面可将 metadata 与 audit 分别放入独立的 PostgreSQL 15+ 数据库,完整迁移、最小权限和回滚流程见 部署指南。
源码二进制构建需要 Go 1.25、cgo、C 编译器和 glibc 兼容环境;普通构建直接使用仓库已有的内嵌控制台产物,不需要 Node.js。
make build VERSION=v0.4.0
./bin/agentsqlctl init-config -o config.yaml
export AGENTSQL_SECRET="$(openssl rand -base64 24)"
export AGENTSQL_ADMIN_USER='admin'
export AGENTSQL_ADMIN_PASSWORD="$(openssl rand -base64 24)"
./bin/agentsql serve -c config.yamlWindows PowerShell:
./bin/agentsqlctl.exe init-config -o config.yaml
$bytes = [byte[]]::new(24); $rng = [System.Security.Cryptography.RandomNumberGenerator]::Create(); $rng.GetBytes($bytes); $env:AGENTSQL_SECRET = [Convert]::ToBase64String($bytes); $rng.Dispose()
$env:AGENTSQL_ADMIN_USER = 'admin'
$passwordBytes = [byte[]]::new(24); $passwordRng = [System.Security.Cryptography.RandomNumberGenerator]::Create(); $passwordRng.GetBytes($passwordBytes); $env:AGENTSQL_ADMIN_PASSWORD = [Convert]::ToBase64String($passwordBytes); $passwordRng.Dispose()
./bin/agentsql.exe serve -c config.yamlagentsqlctl check-config -c config.yaml 只校验配置,不要求凭据;agentsqlctl migrate -c config.yaml 会校验 SECRET 后执行元数据库迁移。
MCP 接入
先在控制台创建 Agent、配置数据源和授权策略,并保存只显示一次的 asql_... API Key。
stdio
{
"mcpServers": {
"agentsql": {
"command": "/absolute/path/to/agentsql",
"args": ["mcp", "--config", "/absolute/path/to/config.yaml"],
"env": {
"AGENTSQL_SECRET": "<YOUR_32_BYTE_SECRET>",
"AGENTSQL_API_KEY": "<YOUR_AGENTSQL_API_KEY>"
}
}
}
}Streamable HTTP
本地端点为 http://127.0.0.1:7780/mcp;非本机部署必须在前面配置 HTTPS 反向代理。
{
"mcpServers": {
"agentsql-http": {
"url": "http://127.0.0.1:7780/mcp",
"headers": {
"Authorization": "Bearer <YOUR_AGENTSQL_API_KEY>"
}
}
}
}网关提供 7 个 MCP 工具:list_datasources、list_schema、explain_query、query、execute_write、request_approval、get_approval_result。
功能矩阵
能力 | 当前代码 | 说明 |
MCP stdio / Streamable HTTP | 支持 | HTTP 使用 Bearer API Key;stdio 绑定单个 Agent Key |
Agent 与数据源管理 | 支持 | API Key 仅创建/轮换时返回明文,库内保存哈希 |
PostgreSQL / MySQL SQL 解析 | 支持 | 结构化 AST 判定,不依赖文本正则代替解析 |
表级与列级授权 | 支持 | 默认拒绝;特殊 JOIN/通配语义见“已知限制” |
只读、危险语句、限流与 Explain 风险规则 | 支持 | 四态结果:allow / deny / approve / warn |
受控查询与写入 | 支持 | 超时、连接上限、结果截断与错误脱敏 |
人工审批 | 支持 | 建单、管理员决定、Agent 查询结果 |
列级脱敏 | 支持 | 九类型按能力矩阵使用 |
表.列感知脱敏与安全兜底 | 支持 | 规则支持全局列、 |
SQLite / PostgreSQL 控制面、审计导出与仪表盘 | 支持 | SQLite 默认零配置;PostgreSQL 可使用独立 metadata/audit 库 |
Webhook / Syslog 通知外发 | 支持 | live-only、best-effort;默认仅 deny/error,审计库仍是权威记录 |
Web 管理控制台 | 支持 | 可用 |
大屏实时事件流 | 支持 | SSE,默认开启,最多 100 条并发管理端连接 |
数据库兼容矩阵
用途 | 数据库 | 当前代码 |
被防护业务库 | MySQL 8 | 支持 |
被防护业务库 | PostgreSQL 14 / 15 / 16 / 17 / 18 | 支持 |
元数据与审计库 | SQLite | 支持,默认零配置,可 combined 存储 |
元数据与审计库 | PostgreSQL 15+ | 支持;PG18 为基准,可 combined 或独立 metadata/audit 库 |
控制面迁移 | SQLite → PostgreSQL |
|
已知限制与安全边界
脱敏按全局列、
表.列、模式.表.列三档作用域在结果层匹配:能唯一归属到物理表的顶层直接投影列按来源表/来源列精确命中;无法确定归属(JOIN 裸列、SELECT *、CTE 外层)且可能涉及受保护表的列会 fail-closed 固定阻断为***。对敏感列做函数/表达式包裹并改名(如CONCAT(phone,'') AS x)、聚合、CAST、UNION、视图内部重命名仍无法溯源;该能力不是完整 DLP,防绕行还需结合只读数据库账号、列级权限、安全视图与审批。hash是不可逆指纹,不是加密,也不能解密还原。它在业务数据库返回结果后计算,不下推到数据库内的 JOIN/WHERE;确定性会暴露相等关系和频率,共享同一 key 还会带来跨库关联风险。block不输出原值字符、长度或等值关系,但仍保留结果集行列形状、行数、列名、是否有结果,并因空值原样返回而暴露该格为空/NULL;它不是匿名化。block在数据库执行后处理,不减少数据库读取,也不阻止数据库侧使用原值做 WHERE/JOIN/GROUP BY,只阻止结果单元对外返回。其固定***是不透明字符串,不保证数值、日期或 JSON 的 schema 兼容。多表 JOIN 与自连接的授权只做表级,列级白名单不随投影列归属收紧;脱敏层则可对已用表名或别名限定的 JOIN 投影列精确归属,未限定的裸列按 fail-closed 兜底处理。
AllowedTables中的*或schema.*表示管理员显式授予匹配表的全部列;此时精确列白名单不再收紧。单表使用精确列白名单时,应显式列出投影列。PostgreSQL 的 B2 列级授权出厂默认开启;普通 schema-qualified 基表使用免扩展的
CATALOG_CLOSED_V1,原生 binder 仅用于可选增强。MySQL 不进入 B2 PostgreSQL 路径。B5 跨请求逻辑会话与 PostgreSQL 计划事务出厂默认开启;MySQL 跨请求事务不支持,配置
mcp.transactions.mysql: true会拒绝启动。每个 operation 仍只允许一条顶层 SQL,并受预检计划和会话安全边界约束。
本地测试模式
AGENTSQL_INSECURE=1 永久只表示“允许公开测试凭据”:它可在本地开发/测试中放行长度正确的公开示例 SECRET 和非空弱管理员口令,但仍拒绝空 SECRET、非 32 字节 SECRET 与空管理员口令。它不会关闭认证、安全规则或 fail-closed 行为,生产环境不得设置。
文档与社区
请不要在公开 Issue 中提交真实密钥、口令、连接串或未修复漏洞细节;未修复漏洞请按 SECURITY.md 走私密渠道。
加入社区(微信)
交流群 #2 | 交流群 #3 | 公众号 | 个人微信 |
|
|
|
|
扫码进群 | 扫码进群 | 扫码关注 | 扫码加好友 |
交流群 #1 已超过 200 人,无法扫码加入:请先添加作者个人微信(崔鹏),备注「AgentSQL」,由群主拉你进群。 群二维码 7 天内有效;若过期请添加个人微信或关注公众号获取最新入群方式。
构建与贡献
go vet ./...
go test -race -count=1 ./...
make build VERSION=v0.4.0pg_query_go 要求 cgo;不要使用 CGO_ENABLED=0 或 Alpine/musl 构建。提交改动前请阅读 SPEC,为行为变化补测试,并保持 tests/corpus 决策语料不被无意改写。
许可、商业授权与商标
开源版本依据 GNU AGPLv3 授权。需要闭源集成、SaaS 商用、企业模块、保修或 SLA 时,请参阅 商业授权说明。AgentSQL(含中文名 “智盾”)名称与 Logo 的商标权保留;可以依许可证 fork 源码,但不得以 AgentSQL / 智盾名称或 Logo 冒充官方版本对外发行。商业授权与企业版合作:87326549@qq.com | https://agentsql.cn 。
This server cannot be deployed
Maintenance
Related MCP Connectors
Safe, read-only Postgres and MySQL access for AI agents. Audit log + column-level controls.
Zero-secret MCP gateway for AI agents: risk-scored, audited calls with human-in-the-loop approval.
Query your warehouse or a CSV with Claude/ChatGPT over MCP, governed by table-level ACL + audit.
Security gateway for AI agents: policy, approval, and audited execution, no secrets shared.
Related MCP Servers
- AlicenseAqualityBmaintenanceSecure MCP server for safe, read-only DB access by AI agents, with SQL guardrails, table allowlists, PII masking, and audit logs634 npm8MIT
- AlicenseNot gradedqualityCmaintenanceEnables AI assistants to interact with PostgreSQL databases through MCP, supporting multi-database and schema access with security controls like read-only mode and SQL auditing.MIT
- FlicenseAqualityBmaintenanceAn MCP server that enables AI agents to securely interact with PostgreSQL databases with least-privilege scopes, PII masking, and human approval for writes.4-
- AlicenseAqualityCmaintenanceA Postgres MCP server that enables AI agents to safely access production databases through deny-by-default YAML policies, PII masking, row limits, and required predicates. It also provides DBA capabilities like index tuning, health checks, and EXPLAIN plans, with support for multiple databases.10MIT



