连接 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 请求，确认只有批准的数据修改能够完成。

接下来阅读