快速入门

最近更新时间:2026-03-27 18:04:26

我的收藏
如果您正在使用 AI 编辑器集成腾讯云即时通信 IM 应用,这里提供完成接入所需的关键资源,包括 MCP、Skills、面向 LLM 的文档入口,以及快速开始示例,支持 Web / iOS / Android / Flutter。
资源导航
MCP Server(必做)
Skills(推荐)

准备账号与凭证(必做)

开始前请先在腾讯云控制台创建应用,并准备以下凭证:
凭证
获取位置
用途
SDKAppID
SDK 初始化、MCP 环境变量。
SecretKey
IM 控制台 → 应用管理
生成 UserSig(仅用于测试)、MCP 环境变量。

配置 MCP(必做)

在您的 AI 编辑器(CodeBuddy / Trae / Cursor / Codex / Claude Code / Claude Desktop 等)里配置 MCP:
{
"mcpServers": {
"tencentcloud-sdk-mcp": {
"command": "npx",
"args": ["-y", "@tencentcloud/sdk-mcp@latest"],
"env": {
"SDKAPPID": "YOUR_SDKAPPID",
"SECRETKEY": "YOUR_SECRET_KEY"
}
}
}
}
查看 CodeBuddy、Trae 、Cursor、Codex、Claude Code、Claude Desktop 等的详细安装说明,请点击 MCP 配置

安装 Skills(推荐)

运行以下命令安装 Skills,CLI 会自动识别您正在使用的工具(CodeBuddy / Trae / Cursor / Codex/ Claude Code / Claude Desktop 等):
npx skills add Tencent-RTC/tencent-rtc-skills
建议安装 Skills,以提高 AI 调用 MCP 工具的稳定性与准确率。详细说明见:Tencent RTC Skills

给 AI 提供文档上下文

除了使用 MCP 调用工具外,您还可以直接把文档 URL 提供给 AI,作为补充上下文。对于需要查 API、找示例、查参数的问题,这种方式通常更直接。
1. 索引文档llms.txt
当您还不确定该看哪篇文档时使用。
https://gitee.com/Tencent-RTC/docs/raw/main/zh/llms.txt
2. 产品聚合文档llms-full-chatkit.txt
当您需要查询 Chat UIKit 更多的信息时,可以直接提供llms-full-chatkit.txt
https://gitee.com/Tencent-RTC/docs/raw/main/zh/llms-full-chatkit.txt
3. 单页 Markdown *.md
当您已经知道具体功能页时使用,先通过llms.txtllms-full-chatkit.txt找到页面,再提供单页面 URL 给 AI。
示例:
https://gitee.com/Tencent-RTC/docs/raw/main/zh/chatkit/features/conversation-list.md

快速开始指南

直接复制下面 Prompt 到 IDE 对话框,集成完整的 Chat UIKit :
任务:集成 Chat UIKit 实现类微信的聊天应用(使用 full-featured 模式并完成最小可运行)

执行要求:
1. 自动识别框架(React/Vue3/Flutter/Android/iOS).
2. 无法识别时,需要调用 `present_framework_choice` 给用户选择。
3. 按平台调用 MCP 工具:
- Web: `get_web_chat_uikit_integration`
- Native: `get_native_chat_uikit_integration`
4. 参数:
- `framework`: 按实际框架填写
- `integrationMode`: `full-featured`
5. 调用 `get_usersig` 获取 2 个测试 userID 的凭证,完成 SDK 初始化与登录。
6. 生成完整聊天入口(会话列表 + 聊天窗口 + 联系人/个人中心)和登录页,用户可选择测试账号登录,并自动补齐路由或页面注册。
7. 启动项目并输出:修改文件、运行命令、验证步骤。

验收清单:
- SDK 初始化成功
- 用户登录成功
- 会话列表可见
- 可以发送和接收消息

常见问题排查:
- userSig 无效:重新调用 `get_usersig`
- 登录失败:检查 `SDKAPPID/SECRETKEY` 环境变量
- 消息不显示:检查会话 ID 格式(例如 `C2Cuserxxx`

约束:
- 不使用过时 API
- 生产环境必须改为服务端签发 UserSig

OpenClaw 指南

如果您想在即时通信 IM 应用中接入 OpenClaw,您可以参考 OpenClaw 快速接入指南

参考

MCP NPM