MCP (Model Context Protocol) 标准化了应用向 LLM 提供上下文的方式。本文介绍如何使用 MCP 集成 IM 的 UIKit 组件,仅支持
stdio 模式传输。MCP 功能特性
说明:
MCP 1.6.0 起覆盖了 Chat 组件、SDK、服务端 API、服务端回调、产品计费与配置相关的查询能力。
功能分类 | 覆盖范围 |
知识咨询 | Chat UIKit 组件( ConversationList、 MessageList、MessageInput、ContactList、Search )、主题配置、本地化多语言、SDK API 文档。 |
| 离线推送 Push 接入、厂商配置信息 。 |
| SDK 错误码(2xxx/3xxx/8xxx)、服务端错误码(消息/群组/关系链/账号/资料等)。 |
| 套餐价格、免费额度、套餐购买、能力限制、多端登录配置、内网代理等。 |
| 服务端接口调用、导入账号、服务端发消息。 |
| Webhook 配置、发消息回调、第三方回调。 |
功能集成 | Web(Vue3/React)UIKit 集成。 |
| Native(Android/iOS/Flutter)UIKit 集成。 |
平台支持 | Web / 小程序 / Android / iOS / Flutter / uni-app(打包 app)等。 |
前置条件
使用 MCP 您需要先在腾讯云控制台创建应用,并获取以下凭证:
凭证 | 用途 | 获取位置 |
SDKAppID | MCP 环境变量。 | |
SecretKey | MCP 环境变量,生成 UserSig (仅用于测试)。 | |
配置 MCP
在 AI 编辑器中配置
在您使用的 AI 编辑器(CodeBuddy / Trae / Cursor / Codex / Claude Code CLI / 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:即时通信 IM 应用 ID。
SECRETKEY:SDKAPPID 对应的密钥,用于集成时生成测试 UserSig,如果您只是查询或排查问题,配置 SDKAPPID 即可。
快速开始指南
知识咨询
复制下面 Prompt 到 IDE 对话框,体验知识咨询能力:
腾讯云即时通信 IM 群内发言之后回调、群聊消息撤回之后回调、群组内单条消息已读回执之后回调的官方文档。
UIKit 集成
复制下面 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
常见问题
Cursor IDE 配置 @tencentcloud/sdk-mcp@latest 连接失败怎么处理 ?
Cursor 配置 MCP 连接失败可能是因为 npx 缓存的问题,请在终端执行以下命令,清除缓存后, reload 重新连接 MCP。
rm -rf ~/.npm/_npx && npm cache verify
附录:全局手动安装
如果需要全局安装,可以在命令行执行以下命令:
npx -y @tencentcloud/sdk-mcp@latest