跳转到主要内容
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 路径。

接下来阅读