文档中心>腾讯云数据库 AI 服务>实践教程>TencentDB-DatabaseClaw Skill 接入实践教程

TencentDB-DatabaseClaw Skill 接入实践教程

最近更新时间:2026-06-25 16:56:48

我的收藏

背景介绍

在 AI Agent 时代,越来越多的企业和开发者通过 AI 编程助手(如 Cursor、Claude Code、Windsurf、CodeBuddy)或 Agent 编排平台(如 LangChain、Dify、CrewAI)来完成日常工作。当 Agent 需要执行数据库运维任务时,例如查慢查询、巡检实例、分析性能,传统方式需要开发者手动调用 API 或编写脚本,打断了 AI 驱动的工作流。
TencentDB-DatabaseClaw Skill 是腾讯云数据库 AI 服务 DatabaseClaw 推出的标准化 Agent Skill 包,帮助 AI Agent 通过自然语言直接调用 DatabaseClaw 的 DBA 专家能力,实现从人工编码对接Agent 自主调用的跨越。

TencentDB-DatabaseClaw Skill 说明

简介

TencentDB-DatabaseClaw Skill 是一个标准化的 AI Agent 技能包,用于让 AI Agent 通过自然语言与腾讯云 DatabaseClaw 实例进行流式对话,实现智能数据库运维。

核心能力

通过 CreateChatCompletion SSE API 向 DatabaseClaw 实例发送消息并接收流式响应。
通过 CreateClawSession 创建会话,确保对话在控制台可追溯。

Skill 包结构

下载解压后,Skill 包的目录结构如下:
TencentDB-DatabaseClaw/
├── SKILL.md # Skill 描述文件(Agent 读取此文件获取能力)
├── scripts/
│ └── chat.py # 可执行客户端(Agent 调用此脚本)
└── references/
└── python-integration.md # 集成参考文档(TC3 签名实现与 SSE 解析)
文件
用途
SKILL.md
定义 Skill 的触发关键词、使用场景、调用协议和参数格式,Agent 读取后自动理解如何调用 DatabaseClaw。
scripts/chat.py
零依赖的 CLI 客户端,支持单消息和交互式多轮对话模式,自动完成 TC3 签名和 SSE 流式解析。
references/python-integration.md
提供完整的 TC3 签名代码、HTTP 请求头格式和 SSE 解析示例,供自定义集成参考。

Skill 下载地址

SkillHub

应用场景

AI 编程助手 + 数据库运维:开发者在 Cursor、Claude Code、CodeBuddy 等 AI IDE 中,直接用自然语言要求 Agent 诊断数据库问题。例如输入“帮我分析广州 MySQL 实例近 7 天的慢查询”,Agent 自动调用 DatabaseClaw 完成分析并返回优化建议,无需离开开发环境。
Agent 工作流编排:在 LangChain、CrewAI、Dify 等 Agent 编排平台中,将 DatabaseClaw 作为工具节点接入多步 Agent 推理链路。例如在自动化发布流程中,Agent 先调用 DatabaseClaw 执行数据库健康检查,确认无异常后再继续部署操作。
自研 Agent 平台集成:企业内部 AI 平台通过标准 Skill 协议挂载 DatabaseClaw 能力,赋能运维团队。平台只需按协议注册 Skill 描述文件和可执行脚本,即可让内部 Agent 获得数据库运维能力。
定时巡检 Agent:Agent 按计划周期性调用 DatabaseClaw 执行巡检,自动检查实例健康状况、内存使用率、连接数等关键指标,异常结果自动推送告警,实现从被动响应到主动运维的转变。
ChatOps Bot:企业 IM Bot(企业微信、飞书)后端集成 Skill,运维人员通过自然语言在聊天窗口中直接查询数据库状态、排查性能问题,降低运维操作门槛。

解决方案

本方案的核心思路是:让 AI Agent 通过标准 Skill 协议获取 DatabaseClaw 的调用能力,Agent 自主决定何时调用、传什么参数,并将结果整合到用户的工作流中

方案架构

本方案的核心思路是:让 AI Agent 通过标准 Skill 协议获取 DatabaseClaw 的调用能力,Agent 自主决定何时调用、传什么参数,并将结果整合到用户的工作流中

本方案架构以用户自然语言为入口,通过标准化 Skill 包实现 AI Agent 与 DatabaseClaw 的自动对接,整体流程如下:
1. 用户提问:用户在任意支持 Skill 的 AI Agent 平台(如 Cursor、Claude Code、CodeBuddy、LangChain、Dify 或自研平台)中,以自然语言描述数据库运维需求。
2. Skill 自动对接:Agent 自动识别意图、匹配已安装的 TencentDB-DatabaseClaw Skill,读取调用协议并发起 API 请求,全程无需用户编码。
3. DatabaseClaw 执行:云端 AI DBA 专家接收请求,自动执行慢查询分析、实例巡检、性能诊断、空间分析等运维操作,支持多轮追问深入诊断。
4. 结果交付:Agent 将诊断结论、优化建议以自然语言返回给用户;同时所有执行记录在 DatabaseClaw 控制台可查,支持审计追溯。
当前支持的数据库类型包括:MySQL、分布式缓存数据库(兼容 Redis)、MongoDB、TDSQL-C。

方案优势

Agent 原生设计:遵循 Skill 标准协议(SKILL.md 描述文件 + scripts/ 可执行脚本),任何支持 Skill 加载的 Agent 框架均可即插即用,无需针对特定平台做适配开发。
零配置调用:Agent 读取 SKILL.md 后自动获知调用域名、签名方式、参数格式和响应解析规则,开发者无需额外编写集成逻辑或指导 Agent 如何调用。
控制台可追溯:每次 Agent 调用自动创建 Session,对话记录在 DatabaseClaw 控制台 可见,支持事后审计与问题追溯,满足企业合规需求。
安全可控:采用 TC3-HMAC-SHA256 签名鉴权机制,Agent 只需持有 API 密钥即可安全调用。结合腾讯云 CAM 权限体系,支持最小权限原则,保障数据库访问安全。
零外部依赖:客户端脚本仅依赖 Python 3.9+ 标准库,无需安装任何第三方包,降低环境配置复杂度,提升部署便利性。
流式响应体验:基于 SSE(Server-Sent Events)流式协议传输,Agent 实时接收 DatabaseClaw 的推理过程和执行结果,支持工具调用事件可视化,提供流畅的交互体验。

实践建议

Skill 配置建议

环境变量优先:密钥通过环境变量传入,不要写入 Skill 配置文件或代码仓库,降低泄露风险。
实例隔离:如有多个 DatabaseClaw 实例,建议为不同业务场景创建独立实例,避免权限交叉。
版本锁定:生产环境建议锁定 Skill 版本,避免自动更新引入不兼容变更。

Agent 调用建议

明确指令:给 Agent 的指令越具体,DatabaseClaw 的回答越精准。例如“分析 cdb-xxxx 广州实例近 7 天慢查询”优于“看看数据库怎么样”。
多轮追问:复杂诊断建议分步进行,先查概况,再针对异常项深入追问。
结果后处理:Agent 可对 DatabaseClaw 返回的结果做二次加工,如提取关键指标、生成报告或触发告警。

安全合规建议

最小权限:为 API 调用创建专用子账号,仅授予 TDAI 相关权限,避免过度授权。
审计追踪:保持 Session 创建开启(默认行为),确保所有 Agent 调用在控制台有记录。
敏感数据防护:注意 Agent 上下文可能包含查询结果中的业务数据,确保 Agent 平台的数据安全策略符合企业合规要求。

高频调用场景建议

探活检测:使用 --no-session 参数避免产生大量空会话记录。
批量巡检:在单次消息中描述完整巡检范围(如“所有地域所有引擎”),让 DatabaseClaw 一次性完成,减少调用次数。
超时处理:复杂的多地域扫描可能需要 60~90 秒,建议将 Agent 的超时设置调整为 120 秒以上。

接入步骤

步骤一:前置准备

条件
说明
腾讯云账号
已完成实名认证
DatabaseClaw 实例
已创建至少一个 DatabaseClaw 实例,且状态为运行中。具体操作请参见 创建 DatabaseClaw 实例
API 密钥
前往密钥管理 获取 SecretId 和 SecretKey。
注意:
若尚未创建密钥,请单击新建密钥,并妥善保管 SecretId 和 SecretKey,以便后续使用。
Agent 环境
任意支持 Skill 加载的 AI Agent 平台(如 Cursor、Claude Code、CodeBuddy、LangChain、Dify、自研平台)。
Python 环境
Python 3.9+(仅需标准库)。

步骤二:下载并安装 Skill

下载 TencentDB-DatabaseClaw Skill 包,解压后将目录放入 Agent 的 Skill 加载路径。
不同 Agent 平台的安装方式:
Agent 平台
安装方式
Cursor / Claude Code
将 Skill 目录放入项目根目录的 skills/ 下。
CodeBuddy
放入项目的 .codebuddy/skills/ 目录,或通过 Skill Hub 安装。
LangChain / CrewAI
注册为 Tool,将 chat.py 封装为可调用函数。
Dify
作为“代码执行”节点接入。
自研平台
按平台 Skill 协议注册 SKILL.md + scripts/

步骤二:配置凭证

Agent 调用 Skill 时需要腾讯云 API 密钥,即步骤一获取的 SecretId 和 SecretKey。推荐通过环境变量配置:
export DBCLAW_SECRET_ID="YOUR_SECRET_ID"
export DBCLAW_SECRET_KEY="YOUR_SECRET_KEY"
export DBCLAW_INSTANCE_ID="clawins-xxxxxxxx"
注意:
请勿将密钥硬编码在代码或 Skill 配置文件中。
建议为 API 调用创建专用子账号,仅授予 QcloudDatabaseClawUserFullAccess 策略,遵循最小权限原则。

步骤三:验证连通性

安装完成后,在 Agent 中发送测试消息验证 Skill 是否正常工作:
帮我用 DatabaseClaw 发送一条 hello 测试消息,验证连接是否正常
Agent 连接正常响应如下:
1. 识别到需要使用 TencentDB-DatabaseClaw Skill。
2. 调用 scripts/chat.py 发送消息。
3. 返回 DatabaseClaw 的自我介绍(DBA 专家助手)。
如果 Agent 成功返回回答,说明 Skill 安装和配置均正确。

步骤四:在控制台查看执行记录

每次 Agent 调用 Skill 时,会自动在 DatabaseClaw 控制台创建会话记录:
2. 在左侧导航栏选择 DatabaseClaw > 实例管理
3. 单击目标实例卡片,进入对话页面。
4. 在左侧会话列表中,可看到 Agent 发起的每次对话。
5. 会话标题为用户发送的消息内容,方便识别来源。
6. 单击会话可查看完整的 Agent 推理过程和工具调用记录。
说明:
如果 Agent 调用频率较高(如定时探活检测),可在调用时传入 --no-session 参数跳过会话创建,避免产生过多记录。

Agent 对话示例

示例一:慢查询分析

在 Agent 中输入:
分析广州地域 MySQL 实例近 7 天的慢查询 TOP 10,给出索引优化建议
Agent 调用 Skill 后,DatabaseClaw 将:
1. 连接目标数据库获取慢查询日志。
2. 按执行耗时排序,输出 TOP 10 慢 SQL。
3. 对每条 SQL 分析执行计划,给出针对性的索引优化建议。

示例二:实例巡检

对所有地域的 Redis 实例做一次巡检,检查内存使用率和连接数,列出超过 80% 的实例
Agent 调用 Skill 后,DatabaseClaw 将:
1. 遍历所有地域的 Redis 实例。
2. 检查每个实例的内存使用率和连接数指标。
3. 筛选出超过 80% 阈值的实例并汇总输出。

示例三:性能诊断

查看 cdb-xxxxx 最近 1 小时的 CPU 使用率趋势,分析是否存在周期性尖峰
Agent 调用 Skill 后,DatabaseClaw 将:
1. 获取目标实例近 1 小时的 CPU 监控数据。
2. 分析使用率变化趋势,识别是否存在周期性尖峰。
3. 如存在异常,给出可能的原因分析和优化建议。

示例四:跨实例对比

对比广州和上海两个地域的 MySQL 实例数量和规格分布
Agent 调用 Skill 后,DatabaseClaw 将:
1. 分别查询广州和上海地域的 MySQL 实例列表。
2. 按规格分类统计实例数量。
3. 输出对比结果,帮助了解资源分布情况。

示例五:多轮追问诊断

# 第一轮
帮我检查广州 MySQL 主实例的整体健康状况

# 第二轮(基于第一轮结果继续追问)
刚才检查中提到的磁盘使用率偏高,帮我分析是哪些表占用空间最大
Agent 在同一 Session 中进行多轮对话,DatabaseClaw 能够理解上下文关系,持续深入诊断。

示例六:命令行直接调用

如需直接通过命令行调用(不经过 Agent 框架),可使用 scripts/chat.py
# 单消息模式(结果输出到标准输出)
python3 scripts/chat.py \\
--instance-id clawins-xxxxxxxx \\
--secret-id YOUR_SECRET_ID \\
--secret-key YOUR_SECRET_KEY \\
--message "查询近7天慢查询 TOP 10"

# 详细模式(显示工具调用过程)
python3 scripts/chat.py -v \\
--instance-id clawins-xxxxxxxx \\
--secret-id YOUR_SECRET_ID \\
--secret-key YOUR_SECRET_KEY \\
--message "巡检所有 MySQL 实例"

# 交互式多轮对话模式(省略 --message 参数)
python3 scripts/chat.py \\
--instance-id clawins-xxxxxxxx \\
--secret-id YOUR_SECRET_ID \\
--secret-key YOUR_SECRET_KEY

常见问题

Q1:Agent 没有自动识别到 Skill 怎么办?

检查 Skill 安装路径是否正确。Agent 通常通过扫描 skills/ 目录下的 SKILL.md 文件来发现可用 Skill。确认:
目录名为 TencentDB-DatabaseClaw(或符合平台命名规范)。
SKILL.md 文件存在且内容完整。

Q2:调用时报 InternalError 错误?

这是域名配置错误的典型表现。CreateChatCompletion 接口必须请求 SSE 流式域名 tdai.ai.tencentcloudapi.com,不能使用管理接口域名 tdai.tencentcloudapi.com。如果使用 Skill 自带的 chat.py,域名已自动正确配置。

Q3:Agent 调用 Skill 但控制台看不到会话记录?

可能原因:
1. Agent 传入了 --no-session 参数,跳过了会话创建。
2. Agent 直接调用了 CreateChatCompletion 但未先调用 CreateClawSession
使用 Skill 默认行为(不传 --no-session)即可自动创建 Session,确保对话在控制台可见。

Q4:能否让多个 Agent 共用同一个 DatabaseClaw 实例?

可以。DatabaseClaw 实例支持并发调用,不同 Agent 通过各自的 API 密钥鉴权后,会创建独立的 Session。控制台中可按时间和会话标题区分不同来源的调用。

Q5:Skill 支持哪些 Agent 平台?

本 Skill 遵循通用的 Skill 协议(SKILL.md 描述 + scripts/ 可执行脚本),理论上支持任何能读取描述文件并执行脚本的 Agent 平台,包括但不限于:
AI IDE 助手:Cursor、Claude Code、Windsurf、CodeBuddy
Agent 框架:LangChain、CrewAI、AutoGen、Dify
自研平台:任何支持“描述 + 脚本”模式的 Agent 系统