概述
TUIKit 开发者文档 MCP 工具 - 通过模型上下文协议访问实时音视频通信的官方开发文档、框架、API、TUIKit。它旨在成为您的 AI 代码集成助手,让您在 AI 代码编辑器(例如:CodeBuddy、Trae、Cursor)中,通过自然语言即时获取所需的集成文档、示例代码和技术指南。
主要功能特性
智能搜索:智能搜索 TUIKit、组件 API、WebRTC 等 RTC 开发者文档。
智能推荐:根据自然语言描述,推荐合适的框架和平台选择。
智能获取用户签名:通过自然语言描述,快速获取登录所需的用户签名(userSig)。
多平台支持:完整的 Web、iOS、Android、Flutter 文档支持。
环境要求
Node.js: 推荐使用 18.x 或 20.x 系列的稳定版本。
版本要求: Node.js 18 或更高版本。
MCP 安装配置
1. AI 编辑器配置(推荐)
在您使用的 AI 代码编辑器(例如:CodeBuddy、Trae、Cursor)的配置面板中,找到 MCP 选项并进行手动配置。
{"mcpServers": {"tencentcloud-sdk-mcp": {"command": "npx","args": ["-y", "@tencentcloud/sdk-mcp"],"env": {"SDKAPPID": "YOUR_SDKAPPID","SECRETKEY": "YOUR_SECRET_KEY"}}}}
2. 全局手动安装(高级)
如果需要全局安装,可以在命令行执行以下命令:
npx -y @tencentcloud/sdk-mcp
使用示例
开发者可以直接在 AI 编辑器中用自然语言提问,MCP 将返回相应的代码、文档或配置。
1. TUIKit AI 集成助手(代码生成与集成)
快速集成 Chat UIKit
1. 使用 TUIKit 组件创建一个 vue3 聊天应用。2. 使用 TUIKit 组件创建一个 react18 聊天应用。
快速集成 CallKit
1. 使用 TUICallkit 组件创建一个 vue3 音视频通话应用。2. 使用 TUICallkit 组件创建一个 react18 音视频通话应用。
在已有项目中集成
1. 在 src/components/chat.vue 中集成 vue3 Chat TUIKit 组件(完整)// 集成完整的 Chat TUIKit 组件2. 在 src/components/call.vue 中集成 vue3 TUICallKit 组件。// 集成 CallKit 音视频通话组件
2. 查询组件详情与 API
获取组件使用说明
1. 获取 ConversationList 组件使用说明。2. 获取 MessageList 组件使用说明。3. 获取 MessageInput 组件使用说明。4. 获取视频直播组件 LiveView 使用说明。5. 获取直播观看页面 LivePlayer 实现指南。
获取 API 详情
1. 获取 TUICallKit 组件 API 详情。2. 获取 TUICallKit 组件开启虚拟背景 API。3. 获取 LiveKit state API 详情。
MCP 可用工具列表
这些工具是 MCP 响应自然语言查询的基础能力,开发者可以通过查询来调用这些功能。
工具 | 描述 | 主要功能 |
present_framework_choice | 框架选择 | 智能引导: 在未指定框架或平台时,引导用户进行选择。 |
get_usersig | 用户签名(userSig)生成 | 安全登录:根据配置的 SDKAppID 和 secretKey ,生成用户登录的 userSig。 |
get_web_chat_uikit_integration | Web 聊天 UIKit 完整集成 | 一站式集成:提供完整的 Web 聊天界面集成方案、示例代码和产品代码。 |
get_web_chat_window_integration | Web 聊天窗口集成 | 核心功能集成: 专注于核心聊天功能,快速构建聊天窗口。 |
get_web_chat_uikit_component_detail | Web 聊天 UIKit 组件详情 | 组件定制:提供 UI 组件(如会话列表、输入框)详细使用说明,方便自定义。 |
get_web_chat_uikit_init | Web 聊天 UIKit 初始化 | 核心初始化:提供核心 API、示例代码和操作步骤,用于初始化登录和激活默认会话。 |
get_native_chat_uikit_integration | 原生聊天 UIKit 完整集成 | 提供原生应用(如 iOS/Android)的完整聊天界面集成方案和集成文档。 |
get_chat_faq | 聊天常见问题解答 | 问题排查:汇集聊天功能集成和使用中的常见问题和解决方案。 |
get_web_call_uikit_integration | Web 音视频通话 UIKit 集成 | 音视频集成:提供 Web 端音视频通话功能的集成方案和 CallKit 示例。 |
get_web_call_uikit_api | Web 音视频通话 UIKit API 说明 | 深度定制开发:提供 CallKit 组件的 API 接口详细说明,方便深度定制。 |
get_native_call_uikit_integration | 原生音视频通话 UIKit 集成 | 提供原生应用(如 iOS/Android)的音视频通话 CallKit 组件集成文档。 |
get_call_faq | 音视频通话常见问题解答 | 问题排查:汇集音视频通话功能集成和使用中的常见问题和解决方案。 |
get_web_live_uikit_component_detail | Web 直播 UIKit 组件详情 | 直播界面:提供 Web 端 LiveKit 组件的使用说明,方便集成直播相关的界面。 |
get_web_live_state_detail | Web 直播 LiveKit 组件 State API 详情 | 深度定制开发:提供 LiveKit 组件的状态(State)管理详细文档,方便深度定制。 |
get_trtc_web_sdk_integration_guide | WebRTC SDK 集成指南 | 基础通信:提供基础 WebRTC SDK 集成指引和示例,用于音视频实时通信。 |
get-rtcengine-web-sdk-integration-guide | RTC 引擎 Web SDK 集成指南 | 底层开发:提供底层 RTC 引擎的 Web SDK 集成指引。 |
get_trtc_web_sdk_faq | WebRTC 常见问题解答 | 问题排查:汇集 WebRTC 开发中的常见问题与解决方案。 |