概述
TUIKit 开发者文档 MCP 工具 - 让 AI 助手可以访问实时音视频通信的完整开发文档、框架、API 等。通过模型上下文协议（MCP），您可以在 CodeBuddy、Trae、Cursor 等 AI 编程工具中，直接用自然语言提问，即可获取集成指南、API 文档和代码示例，提升开发效率。
主要功能特性
智能搜索：智能搜索 TUIKit、组件 API、WebRTC 等 RTC 开发者文档。
智能推荐：根据自然语言描述，推荐合适的框架和平台选择。
智能获取用户签名：通过自然语言描述，快速获取登录所需的用户签名（userSig）。
多平台支持：完整的 Web、iOS、Android、Flutter 文档支持。
环境要求
Node.js：推荐使用 18.x 或 20.x 系列的稳定版本。
SKILLS 安装
在 MCP 的基础上我们提供了 skills 技能包，skills + MCP 组合使用能够获得更好的集成体验，您可以从 GitHub tencent-rtc-skills 获取 skills，然后导入到您的 AI 编辑器中。
获取 skills 方式：
git clone https://github.com/Tencent-RTC/tencent-rtc-skills.git ~/.skills/tencent-rtc-skills
MCP 安装配置
AI 编辑器配置（推荐）
在您使用的 AI 代码编辑器（例如：CodeBuddy、Trae、Cursor）的配置面板中，找到 MCP 选项并进行手动配置。
{"mcpServers": {"tencentcloud-sdk-mcp": {"command": "npx","args": ["-y", "@tencentcloud/sdk-mcp@latest"],"env": {"SDKAPPID": "YOUR_SDKAPPID","SECRETKEY": "YOUR_SECRET_KEY"}}}}
全局手动安装（高级）
如果需要全局安装，可以在命令行执行以下命令：
npx -y @tencentcloud/sdk-mcp@latest
使用示例
开发者可以直接在 AI 编辑器中用自然语言提问，MCP 将返回相应的代码、文档或配置。
快速集成 UI 组件
集成 UI 组件可以参考下面的示例提示词或根据您的实际需求进行描述。
1. 使用 TUIKit 组件创建一个 vue3 聊天应用。2. 使用 TUIKit 组件创建一个 react18 聊天应用。3. 在项目中帮我集成 Flutter Chat UIKit。4. 在项目中帮我集成 Android Chat UIKit。5. 在项目中帮我集成 iOS Chat UIKit。
1. 使用 TUICallkit 组件创建一个 vue3 音视频通话应用。2. 使用 TUICallkit 组件创建一个 react18 音视频通话应用。3. 在项目中帮我集成 Flutter TUICallKit。4. 在项目中帮我集成 Android TUICallKit。5. 在项目中帮我集成 iOS TUICallKit。
1. 用 RoomKit 组件实现一个 PC 的视频会议应用。2. 用 RoomKit 组件实现一个适配 H5 视频会议应用。3. 用 RoomKit 组件实现一个适配 PC + H5 的视频会议应用。4. 用 RoomKit State API 实现一个适配 h5 的视频会议应用。5. 在我的项目中用 RoomKit 组件实现一个视频会议应用。
1. 用 vue3 LiveKit 组件实现一个 web 的直播应用，包含开播、直播列表、直播观看功能。2. 在我的项目中用 vue3 LiveKit 组件实现一个包含开播、直播列表、观看功能的应用。3. 在项目中帮我集成 Flutter LiveKit 开播、观看以及连麦功能。4. 在项目中帮我集成 Android LiveIKit 开播、观看以及连麦功能。5. 在项目中帮我集成 iOS LiveKit 开播、观看以及连麦功能。
UI 组件定制
UI 组件定制可以参考下面的示例提示词或根据您的实际需求进行描述。
1. 查询 MessageList 组件的功能帮我实现一下自定义消息卡片，自定义消息卡片需要和普通消息一样显示头像。2. 关闭 Message 卡片撤回和删除操作。3. 关闭 MessageInput 组件的文件和视频上传功能。4. 我不需要会话列表的置顶会话功能，帮我隐藏一下。5. 我不需要全局搜索功能，把全局搜索功能关掉。
1. 我需要开启 TUICallKit 虚拟背景功能。2. 帮我查询一下 TUICallKit 客户端 API 列表。3. 帮我开启 Flutter TUICallKit 来电横幅功能。4. 帮我实现一下 Android TUICallKit 的虚拟背景。5. iOS TUICallKit 怎么自定义铃声。
1. 帮我把 RoomKit 的基础美颜功能隐藏掉。2. 根据参会者角色帮我把【结束】按钮文案调整为结束会议和离开会议。3. 我不需要全体静音和全体静画功能，帮我处理一下。4. 帮我把房间的布局改为侧边栏布局。5. 帮我把房间的布局改为顶部栏布局。
1. 根据 Livekit State API 使用一下连麦功能。2. 我不需要连麦管理面板，帮我隐藏一下。3. 帮我实现 Flutter LiveKit 的基础美颜功能。4. 帮我实现 Android LiveKit 礼物和弹幕功能。5. 帮我实现 iOS LiveKit 音效控制功能。
MCP 可用工具列表
这些工具是 MCP 响应自然语言查询的基础能力，开发者可以通过查询来调用这些功能。
工具 | 描述 | 主要功能 |
present_framework_choice | 框架选择 | 智能引导：在未指定框架或平台时，引导用户进行选择。 |
get_faq | 常见问题解答 | 问题排查：汇集聊天、视频会议、音视频通话、直播、WebRTC 集成和使用中的常见问题和解决方案。 |
get_usersig | 用户签名（userSig）生成 | 安全登录：根据配置的 SDKAppID 和 secretKey，生成用户登录的 userSig。 |
get_web_chat_uikit_integration | Web 聊天 UIKit 完整集成 | 一站式集成：提供完整的 Web 聊天界面集成方案和核心聊天功能集成支持。 |
get_web_chat_uikit_component_detail | Web 聊天 UIKit 组件详情 | 组件定制：提供 UI 组件（例如会话列表、输入框）详细使用说明，方便自定义。 |
get_native_chat_uikit_integration | Native 聊天 UIKit 完整集成 | 提供 Native 应用（例如 iOS/Android/Flutter）的完整聊天界面集成方案和集成文档。 |
get_native_chat_feature_detail | Native 聊天 UIKit 组件和功能详情 | 组件定制：提供 UI 组件（例如会话列表、输入框）和功能的详细使用说明，方便自定义。 |
get_web_call_uikit_integration | Web 音视频通话 UIKit 集成 | 音视频集成：提供 Web 端音视频通话功能的集成方案和 CallKit 示例。 |
get_web_call_uikit_api | Web 音视频通话 UIKit API 详情 | 深度定制开发：提供 CallKit 组件的 API 接口详细说明，方便深度定制。 |
get_native_call_uikit_integration | Native 音视频通话 UIKit 集成 | 提供 Native 应用（例如 iOS/Android/Flutter）的音视频通话 CallKit 组件集成文档。 |
get_web_live_uikit_integration | Web 直播 LiveKit 集成 | 直播集成：提供 Web 端 LiveKit 组件集成。 |
get_web_live_uikit_component_detail | Web 直播 LiveKit 组件详情 | 组件定制：提供 UI 组件详细使用说明，方便自定义。 |
get_web_live_state_detail | Web 直播 State API 详情 | 深度定制开发：提供 LiveKit 组件 State API 详细文档，方便深度定制。 |
get_native_live_uikit_integration | Native 直播 LiveKit 集成 | 提供 Native 应用（例如 iOS/Android/Flutter）的开播、观看、观众列表等功能的集成文档。 |
get_native_live_uikit_interaction | Native 直播互动功能集成 | 提供 Native 应用（例如 iOS/Android/Flutter）的连麦、PK、观众管理等功能的集成文档。 |
get_native_live_uikit_extra_features | Native 直播基础功能集成 | 提供 Native 应用（例如 iOS/Android/Flutter）的基础美颜、音效控制、弹幕互动等组件集成文档。 |
get_web_room_uikit_integration | Web 音视频会议 RoomKit 集成 | 视频会议集成：提供 Web 端视频会议功能的集成。 |
get_web_room_feature_detail | Web 音视频会议 RoomKit 组件和 State API 详情 | 深度定制开发：提供 RoomKit 组件和 State API 详细文档，方便深度定制。 |
get_trtc_web_sdk_integration_guide | WebRTC SDK 集成指南 | 基础通信：提供基础 WebRTC SDK 集成指引和示例，用于音视频实时通信。 |
get-rtcengine-web-sdk-integration-guide | RTC 引擎 Web SDK 集成指南 | 底层开发：提供底层 RTC 引擎的 Web SDK 集成指引。 |
