文档 | hs-sql-agent

产品介绍

了解 hs-sql-agent 的安全边界，并选择合适的使用方式。

快速开始

在 Docker、HsSqlAgent.Hosting 和 HsSqlAgent.Server 之间选择，并连接第一个 MCP Client。

02

MCP

2

连接 MCP 客户端

签发 MCP 密钥后直接复制自动生成的客户端配置，并在启用 DML 前确认 Elicitation 支持情况。

MCP 工具参考

hs-sql-agent 的内置 MCP 工具契约，涵盖查询、元数据发现以及需审批 DML 的结构化结果。

03

SQL 编译器

4

SQL 执行模型

了解 hs-sql-agent 如何把不可信 SQL 转换为经过验证、面向具体数据库的语句后再执行。

Safe DML

审批一个或多个 DML，重新验证精确证据，并在单一事务中原子提交获批内容。

数据库方言

介绍统一 MCP 接口背后的六种数据库支持，以及 SQL 方言“有限支持”的具体含义。

SQL 支持参考

hs-sql-agent 的 SQL 语法和 provider capability 人类可读摘要。

04

管理

10

管理界面概览

用于管理数据库访问、MCP 凭据、身份、授权、审计、安全策略和运行时运维的控制平面。

数据库管理

配置和运维通过 hs-sql-agent 暴露的数据库连接。

MCP 密钥

在 hs-sql-agent 中签发、限制、轮换、复制和撤销 MCP 凭据。

自定义工具

在不绕过 hs-sql-agent 策略的前提下，构建并发布用途明确的 Query 或 DML MCP 工具。

05

语义元数据

在 hs-sql-agent 中使用表/列语义、关系和指标元数据增强数据库发现。

06

成员与角色

管理 hs-sql-agent 的管理用户、会话、角色分配和角色生命周期。

07

权限

了解 hs-sql-agent 管理操作使用的 permission path + action 授权模型。

08

审计

从管理控制平面查询、汇总、导出并保留 hs-sql-agent 审计记录。

09

安全策略

从管理控制平面配置 hs-sql-agent 的 SQL、DML、限流和并发运行时策略。

10

运行状态

查看 hs-sql-agent 的运行时执行指标、数据库健康、MCP 密钥使用情况和出站投递。

05

集成

2

ASP.NET Core 集成

嵌入完整第一方产品时使用 HsSqlAgent.Hosting；需要由宿主掌握边界与能力组合时使用 HsSqlAgent.Server。

使用 System-to-System API Key 调用管理 API

在 Admin UI 签发 Key，让外部后端调用现有管理 REST API。

06

运维

4

配置参考

配置独立 Docker、标准 HsSqlAgent.Hosting 或模块化 HsSqlAgent.Server Host。

可观测性与审计运维

配置健康探测、慢查询阈值、Prometheus、OTLP、审计保留和签名出站投递。

部署

hs-sql-agent 独立服务、标准嵌入和模块化 Host 的生产环境部署指南。

分布式部署

在同一服务端点后运行多个 hs-sql-agent 实例时需要共享的状态和协调能力。

07

安全

2

OIDC SSO 与 TOTP MFA

配置企业 OIDC 身份、claim 映射、角色预配、MFA 策略和持久化 data-protection key。

安全概览

了解如何通过服务器端控制把数据库治理放在 LLM 之外，以及保护这些控制措施的运维配置。

08

开发

1

架构

hs-sql-agent 的产品组合、SQL Compiler 边界和 DML 审批架构。

09

参考

4

故障排查

根据 hs-sql-agent 的运行时不变量诊断常见配置和兼容性问题。

管理 REST API Reference

逐项查看管理 API 的请求／响应模型字段、类型、必填及 Nullable。

使用 Key 调用现有 API：Request／Response

使用 Admin UI 签发的 Key 调用现有管理 API，附实际 JSON 示例。