跳至主要內容
hs-sql-agent
2.0.2
文件 2.0.2
文件 開始使用

快速開始

選擇部署方式、啟動 hs-sql-agent,並連接第一個 MCP 用戶端。

Docker Compose

  1. 建立環境設定檔

    複製儲存庫中的範例檔,讓設定保持明確並方便審查。

    cp .env.example .env
  2. 更換簽章密鑰

    HMAC_KEY 與 JWT_KEY 請分別使用不同、至少 32 位元組的唯一密鑰。

    .env.example 中的值只是範例,請勿原樣部署到正式環境。

  3. 啟動服務

    啟動預設的單一執行個體服務。

    docker compose up -d
  4. 開啟管理介面

    應用程式預設監聽 8080 連接埠。

    本機環境可開啟 http://localhost:8080,然後完成第一個管理員設定。

發行第一把 MCP 金鑰

  1. 開啟 Runtime → MCP Keys

    MCP 金鑰是用戶端身分與授權檢查的邊界。

  2. 選擇資料庫與工具權限範圍

    把金鑰綁定到一個 Database Management 項目,並且只開放用戶端實際需要的工具。

  3. 複製明文金鑰

    金鑰發行後會在生命週期對話框中顯示一次,請複製並保存到用戶端的安全憑證儲存位置。

  4. 使用自動產生的用戶端設定

    也可以透過 X-MCP-Server-Key 要求標頭,把密鑰傳送到 Streamable HTTP 端點。

預設 MCP 端點是 /mcp。如果用戶端不在本機,請把 MCP_PUBLIC_ENDPOINT 設為外部可存取的 HTTP 或 HTTPS 絕對 URL,並包含 /mcp 路徑。

接下來閱讀