MCP 提供了 IM 知识咨询和含 UI 集成的 AI 解决方案。您可以在 AI 编辑器里配置 MCP,帮您快速准确的查询即时通信 IM 相关文档内容和实现功能集成。以上能力覆盖 Web/Android/iOS/Flutter/uni-app(打包 App) 等平台。
说明:
MCP 1.6.0 起覆盖了 Chat 组件、SDK、服务端 API、服务端回调、产品计费与配置相关的查询能力。
能力清单
能力场景 | 能力说明 | 示例 |
知识咨询 | 查询 UI 组件(ConversationList、MessageList 等)的用法。 | “@tencentcloud-sdk-mcp Vue3 MessageList 组件如何渲染自定义消息卡片?” |
| 查询无 UI SDK API 用法。 | “@tencentcloud-sdk-mcp H5 集成 Web IM SDK 怎么发送语音消息?” |
| 查询 SDK 和服务端错误码含义与处理建议。 | “@tencentcloud-sdk-mcp Web IM SDK 登录时什么情况会 2025 错误码?” |
| 查询服务端 REST API(导入账号、服务端发消息等)用法。 | “@tencentcloud-sdk-mcp REST API 怎么在群组中发送自定义消息?” |
| 查询 Webhook 配置、第三方回调对接方式。 | “@tencentcloud-sdk-mcp IM 回调 State.StateChange 状态变更回调的请求体字段格式是什么?” |
| 查询套餐价格、能力限制、多端登录配置、内网代理配置。 | “@tencentcloud-sdk-mcp Web IM SDK 怎么实现内网代理?” |
| 查询离线推送 Push 接入方式、厂商配置和常见注意事项。 | “@tencentcloud-sdk-mcp iOS 离线推送证书怎么配置?” |
代码集成 | MCP 根据上下文识别 Vue3/React 框架并生成 UIKit 代码。 | “@tencentcloud-sdk-mcp 帮我在 Vue3 项目中集成 Chat UIKit 完整功能。” |
| MCP 根据上下文识别 Android/iOS/Flutter 平台并生成 UIKit 代码。 | “@tencentcloud-sdk-mcp 帮我在 Flutter 项目接入完整的 Chat UIKit 功能。” |
错误排查 | 结合报错信息诊断集成 UIKit 或 SDK 过程中遇到的各种问题。 | “@tencentcloud-sdk-mcp 安卓 App 加入项目成功后,IM 报错:Fail to create more groups. This sdkappid has reached group amount max limit.” |
准备账号与凭证
您需要先在腾讯云控制台创建应用,并获取以下凭证(如果您还没有创建应用,支持不配置 SDKAppID 试用。):
凭证 | 用途 | 获取位置 |
SDKAppID | MCP 环境变量,基础查询时配置。 | |
SecretKey | MCP 环境变量,需要 MCP 生成测试 userSig 时配置。 | |
配置 MCP
配置方式
在您的 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。
配置验证
配置保存后,在 IDE 的 MCP 面板中看到
tencentcloud-sdk-mcp 显示为 Connected(绿色)即表示安装成功。快速开始指南
快速唤醒技巧:
在提问时带上
@tencentcloud-sdk-mcp 前缀,可跳过泛意图搜索,直连官方最新的 SDK 和 UI 组件能力,响应速度更快,回复精准。精准唤醒(推荐):“@tencentcloud-sdk-mcp 帮我查一下 H5 集成 Web IM SDK 怎么发送语音消息?”
普通提问:“帮我查一下 H5 集成 Web IM SDK 怎么发送语音消息?”
知识咨询
复制下面 Prompt 到 IDE 对话框,体验知识咨询能力:
@tencentcloud-sdk-mcp 帮我查一下 IM 群内发消息后回调的官方文档。
UIKit 集成
复制下面 Prompt 到 IDE 对话框,实现 Chat UIKit 的集成:
任务:@tencentcloud-sdk-mcp 集成 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