文件 | hs-sql-agent

產品介紹

認識 hs-sql-agent 的安全邊界，並選擇適合的使用方式。

快速開始

在 Docker、HsSqlAgent.Hosting 與 HsSqlAgent.Server 之間選擇，並連接第一個 MCP Client。

02

MCP

2

連接 MCP 用戶端

簽發 MCP 金鑰後直接複製產生的用戶端設定，並在啟用 DML 前確認 Elicitation 支援情況。

MCP Tools 參考

hs-sql-agent 的 built-in MCP Tool 契約，包含原子 multi-statement DML。

03

SQL 編譯器

4

SQL 執行模型

說明 hs-sql-agent 如何把不可信 SQL 轉換成經過驗證、符合目標資料庫的語句後再執行。

Safe DML

核准一個或多個 DML、重新驗證精確證據，並以單一交易原子提交核准內容。

資料庫方言

介紹統一 MCP 介面背後的六種資料庫支援，以及 SQL 方言「有限支援」的具體含義。

04

SQL 支援參考

hs-sql-agent 的 SQL 語法與六種資料庫 capability 支援摘要。

04

管理

10

管理介面概覽

了解如何管理資料庫存取、MCP 憑證、身分驗證、授權、稽核、安全政策與執行環境。

資料庫管理

設定與操作 hs-sql-agent 對外提供的資料庫連線。

MCP 金鑰

在 hs-sql-agent 簽發、限制、輪替、複製與撤銷 MCP 憑證。

04

Custom Tools

建立並發布特定用途的 Query / DML MCP 工具，同時保留 hs-sql-agent 的完整安全政策邊界。

05

語意中繼資料

用資料表與欄位語意、關聯與指標中繼資料，強化 hs-sql-agent 的 schema discovery。

06

成員與角色

管理 hs-sql-agent 的管理端使用者、工作階段、角色指派與角色生命週期。

07

權限

了解 hs-sql-agent 管理端採用的「權限路徑 + 動作」授權模型。

08

稽核

在管理介面查詢、彙總、匯出與保留 hs-sql-agent 的稽核紀錄。

09

安全政策

從管理介面設定 hs-sql-agent 執行階段的 SQL、DML、速率限制與並行執行政策。

10

運作狀態

檢視 hs-sql-agent 的執行指標、資料庫健康狀態、MCP 金鑰使用情形與外送結果。

05

整合

1

ASP.NET Core 整合

要嵌入完整第一方產品時使用 HsSqlAgent.Hosting；需要由宿主掌握邊界與能力組合時使用 HsSqlAgent.Server。

06

維運

4

設定參考

設定獨立 Docker、標準 HsSqlAgent.Hosting 或模組化 HsSqlAgent.Server Host。

可觀測性與稽核維運

設定健康檢查、慢查詢門檻、Prometheus、OTLP、稽核資料保留，以及帶簽章的外送通知。

部署

hs-sql-agent 獨立服務、標準嵌入與模組化 Host 的正式環境部署指南。

04

分散式部署

多個 hs-sql-agent 執行個體共用服務端點時，需要共享哪些控制平面與協調狀態。

07

安全

2

OIDC SSO 與 TOTP MFA

設定企業 OIDC 身分、claim mapping、角色佈建、MFA 政策與持久化的 data-protection keys。

安全性概觀

說明如何透過伺服器端控制把資料庫治理留在 LLM 之外，以及保護這些控制措施的維運設定。

08

開發

1

架構

hs-sql-agent 的產品組合、SQL Compiler 邊界與 DML 核准架構。

09

參考

3

疑難排解

從 hs-sql-agent 的執行階段不變條件，判斷常見設定與相容性失敗原因。

Admin HTTP API 參考

根據 hs-sql-agent 原始碼整理、供內建管理介面使用的 HTTP controller 路由參考。