連接 MCP 用戶端

hs-sql-agent 在 /mcp 提供 Streamable HTTP MCP 端點。

連接用戶端

1. 發行 MCP 金鑰

   在管理介面建立一把綁定目標資料庫的金鑰。如果用戶端不需要完整權限，請限制它可使用的工具與資料表。

2. 使用公開 MCP 端點

   這個位址必須讓用戶端實際存取。不要假設管理介面與 MCP 端點一定使用相同的主機或連接埠。

3. 驗證每一個要求

   使用下方 MCP 要求標頭傳送金鑰。請把明文金鑰視為敏感憑證；發行或更新對話框關閉後，同一個金鑰不會再次顯示。

4. 驗證實際安裝的用戶端

   先確認結構描述探索與查詢執行正常。如果準備啟用 DML，還應在正式使用前另外測試用戶端的 form Elicitation 行為。

X-MCP-Server-Key: <MCP key>

公開端點

維運介面與自動產生的用戶端設定會使用下列伺服器設定中的 URL：

{
  "Mcp": {
    "PublicEndpoint": "https://sql-agent.example.com/mcp"
  }
}

對應的環境變數是 Mcp__PublicEndpoint。儲存庫提供的 Compose 設定會把 MCP_PUBLIC_ENDPOINT 對應到這個值。

自動產生的用戶端設定

發行、輪替或複製 MCP 金鑰後，管理介面可以立即為 Claude Desktop、Cursor 與一般 Streamable HTTP 用戶端產生直接連線設定。

明文金鑰只會短暫顯示。關閉金鑰生命週期對話框後，伺服器無法再次顯示同一個密鑰值。

DML 相容性需要另外確認

成功連接 /mcp，不代表用戶端也支援 DML 核准。

execute_dml_sql 與已發布的 DML Custom Tools 需要 form Elicitation。正式環境允許 DML 前，請使用實際安裝的用戶端版本驗證以下兩種情況：

1. 拒絕 Elicitation 要求，確認資料修改沒有被認可。
2. 接受 Elicitation 要求，確認只有已核准的資料修改會完成。

接下來閱讀