MCP (Model Context Protocol) 标准化了应用向 LLM 提供上下文的方式。本文介绍如何使用 MCP 集成 IM 的 UIKit 组件,仅支持
stdio 模式传输。说明:
如果您需要在 IDE 中通过 AI 咨询 IM 相关的问题,推荐您直接使用 Skill,Skill 提供了完整的 IM 知识咨询能力,覆盖 SDK、UIKit、产品计费与配置、服务端 API、服务端回调、错误码等全链路知识检索。
MCP 功能
智能集成:支持 Chat UIKit 集成。
功能详情查询: 提供 UI 组件与 API 使用详情。
常见问题查询:常见问题查询工具。
测试 UserSig 生成: UserSig 生成工具(仅用于测试)。
多平台支持:完整的 Web、iOS、Android、Flutter 文档支持。
前置条件
使用 MCP 您需要先在腾讯云控制台创建应用,并获取以下凭证:
凭证 | 用途 | 获取位置 |
SDKAppID | MCP 环境变量。 | |
SecretKey | MCP 环境变量,生成 UserSig (仅用于测试)。 | |
配置 MCP
在 AI 编辑器中配置
在您使用的 AI 编辑器(CodeBuddy / Trae / Cursor / Codex / Claude Code / Claude Desktop 等)配置 MCP。
单击设置 > 选择 MCP > 配置 MCP > 打开 mcp.json 文件,配置以下内容:
{"mcpServers": {"tencentcloud-sdk-mcp": {"command": "npx","args": ["-y", "@tencentcloud/sdk-mcp@latest"],"env": {"SDKAPPID": "YOUR_SDKAPPID","SECRETKEY": "YOUR_SECRET_KEY"}}}}
单击设置 > 选择 Tools & MCP > Add Custom MCP > 打开 mcp.json 文件,配置以下内容:
{"mcpServers": {"tencentcloud-sdk-mcp": {"command": "npx","args": ["-y", "@tencentcloud/sdk-mcp@latest"],"env": {"SDKAPPID": "YOUR_SDKAPPID","SECRETKEY": "YOUR_SECRET_KEY"}}}}
1. 运行以下命令配置 MCP,将 SDKAPPID 和 SECRETKEY 替换为真实的应用信息。
codex mcp add tencentcloud-sdk-mcp \\--env SDKAPPID=YOUR_SDK_APP_ID --env SECRETKEY=YOUR_SECRET_KEY \\-- npx -y @tencentcloud/sdk-mcp@latest
如需项目级配置,可追加
--scope project,写入项目根目录的 .mcp.json。2. 运行
codex mcp list 验证 MCP 是否配置成功,列表中出现 tencentcloud-sdk-mcp 表示配置成功。1. 运行以下命令配置 MCP,将 SDKAPPID 和 SECRETKEY 替换为真实的应用信息。
claude mcp add tencentcloud-sdk-mcp \\--env SDKAPPID=YOUR_SDK_APP_ID --env SECRETKEY=YOUR_SECRET_KEY \\-- npx -y @tencentcloud/sdk-mcp@latest
如需项目级配置,可追加
--scope project,写入项目根目录的 .mcp.json。2. 运行
claude mcp list 验证 MCP 是否配置成功,列表中出现 tencentcloud-sdk-mcp表示配置成功。单击设置 > 选择 Developer > Edit Config > claude_desktop_config.json,配置以下内容:
{"mcpServers": {"tencentcloud-sdk-mcp": {"command": "npx","args": ["-y", "@tencentcloud/sdk-mcp@latest"],"env": {"SDKAPPID": "YOUR_SDKAPPID","SECRETKEY": "YOUR_SECRET_KEY"}}}}
环境变量
SDKAPPID:实时音视频 TRTC 和即时通信 IM 应用 ID。
SECRETKEY:SDKAPPID 对应的密钥,用于生成测试 UserSig。
快速开始指南
直接复制下面 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
给 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.txt 或 llms-full-chatkit.txt 找到页面,再提供单页面 URL 给 AI。示例:
https://gitee.com/Tencent-RTC/docs/raw/main/zh/chatkit/features/conversation-list.md
附录:全局手动安装
如果需要全局安装,可以在命令行执行以下命令:
npx -y @tencentcloud/sdk-mcp@latest