概述
本文档为开发者提供了清晰、高效的步骤，用于在支持 AI 辅助编程的 IDE（例如 Cursor、Trae、CodeBuddy、VSCode）中，通过 Model Context Protocol (MCP) Server 快速集成 TRTC Web SDK 组件，从而通过 AI 自动生成项目初始化和集成代码。通过配置 MCP Server，AI 可以调用 @tencentcloud/sdk-mcp提供的工具集，帮您完成以下工作：
- 帮您自动生成集成代码，您无需手动编写大量重复性代码。
- 帮您解决一些常见问题，给出解决方案。
注意： TRTC Web SDK 又称为 RTC Engine web sdk，下文统一称为 TRTC Web SDK
步骤1：环境准备
1. 基础开发环境准备
确保您的本地开发环境中安装了推荐版本的** Node.js **和 npm (Node Package Manager)。
-
下载与安装：
-
请访问 Node.js 官方网站 下载并安装适用于您操作系统的版本。
-
推荐版本：建议使用 Node.js LTS (长期支持) 版本，通常在 18.x 或 20.x 系列。
-
-
验证安装：
安装完成后，请打开您电脑上的命令窗口（或叫命令提示符、终端），运行以下命令验证版本：
-
** Windows 系统**： 请按下键盘上的
Win键 +R键，输入cmd，然后按回车键打开。 -
Mac 系统： 请按下
Command+空格键，输入终端或Terminal，然后按回车键打开。node -v npm -v -
如果能正确显示版本号，则环境准备完成。
-
如果提示
没有相关命令或其他错误， 请将完整的错误信息截图或文字内容提供给 AI，以便能够更高效地找到解决方案。
-
2. 实时音视频 TRTC 应用信息准备
获取您自己的腾讯云实时音视频 TRTC 应用的凭证信息：
-
注册账号： 注册一个腾讯云账号。
-
创建应用： 在腾讯云控制台创建一个 实时音视频 TRTC 应用。
-
获取密钥： 获取 TRTC 应用的
SDKAppID和secretKey，这将在配置 MCP 时作为环境变量使用。
步骤2：MCP 工具配置
使用 MCP 工具前，您需要在代码编辑器（例如：Cursor、Trae、CodeBuddy、VSCode）的配置面板中设置。推荐您配置到当前项目的根目录下。
【CodeBuddy 配置指引】
-
单击 设置 > **添加 MCP **打开
settings.json配置 MCP。
- 把
mcpServers的配置信息更新到settings.json文件中并进行保存。
{
"mcpServers": {
"tencentcloud-sdk-mcp": {
"command": "npx",
"args": ["-y", "@tencentcloud/sdk-mcp"],
"env": {
"SDKAPPID": "YOUR_SDKAPPID",
"SECRETKEY": "YOUR_SECRET_KEY"
}
}
}
}
**注意：**请及时保存您修改的配置文件。
Windows 用户：
Ctrl+S**，Mac 用户： **Command+S。
- 检查 MCP 工具是否成功加载 tools。
【Trae 配置指引】
-
单击**设置 **> **MCP **> **+添加 **> 手动添加
- 单击**原始配置（JSON）**打开配置文件，把
mcpServers的配置信息更新到配置文件中并进行保存。
{
"mcpServers": {
"tencentcloud-sdk-mcp": {
"command": "npx",
"args": ["-y", "@tencentcloud/sdk-mcp"],
"env": {
"SDKAPPID": "YOUR_SDKAPPID",
"SECRETKEY": "YOUR_SECRET_KEY"
}
}
}
}
**注意：**请及时保存您修改的配置文件。
Windows 用户：
Ctrl+S**，Mac 用户： **Command+S。
- 选择编辑器默认的 Builder with MCP 或者将 MCP 添加到您自定义的 Builder 中。
【Cursor 配置指引】 5. 下载 Cursor
- 在项目根目录下创建
.cursor/mcp.json文件，把mcpServers的配置信息更新到mcp.json中并进行保存。
{
"mcpServers": {
"tencentcloud-sdk-mcp": {
"command": "npx",
"args": ["-y", "@tencentcloud/sdk-mcp"],
"env": {
"SDKAPPID": "YOUR_SDKAPPID",
"SECRETKEY": "YOUR_SECRET_KEY"
}
}
}
}
**注意：**请及时保存您修改的配置文件。
Windows 用户：
Ctrl+S**，Mac 用户： **Command+S。
- 当保存文件时，会弹出下图提示，选择** Enable** 开启 MCP 工具。
- 配置完成，在 Cursor 的 Settings - Tools & MCP 选项中检查 MCP 工具是否成功加载 tools。
【VSCode 配置指引】
- 安装 VS Code CodeBuddy 插件。
- 插件安装成功后，在侧边栏找到 CODEBUDDY 入口，单击 MCP 市场图标 > 已安装 > 配置 MCP Server。
- 把
mcpServers的配置信息更新到配置文件中并进行保存。
{
"mcpServers": {
"tencentcloud-sdk-mcp": {
"command": "npx",
"args": ["-y", "@tencentcloud/sdk-mcp"],
"env": {
"SDKAPPID": "YOUR_SDKAPPID",
"SECRETKEY": "YOUR_SECRET_KEY"
}
}
}
}
**注意：**请及时保存您修改的配置文件。
Windows 用户：
Ctrl+S**，Mac 用户： **Command+S。
- 保存成功后检查 MCP 工具是否成功加载 tools。
步骤3：分场景使用 AI 工具
配置完成后，您即可通过 AI 提示词与 AI 进行对话，快速集成 TRTC Web SDK。
场景一：从零开始创建项目并集成
3.1 创建和初始化项目
输入提示词， AI 帮您自动创建项目，项目创建成功后 AI 会自动在 文件中引入 TRTC Web SDK。
提示词示例：
1. 请使用 TRTC Web SDK 创建一个音视频通话应用。
2. 请使用 TRTC Web SDK 基于 vue3 创建一个音视频通话应用。
3. 请使用 TRTC Web SDK 基于 react18 创建一个音视频通话应用。
3.2 获取登录账号信息
当 AI 将应用创建完成后，您需要使用您自己的 SDKAppID 获取登录的账号信息。
提示词示例：
请使用配置的 SDKAppID 创建一个 userid 和 userSig 并填入代码。
3.3 运行项目
尝试运行项目，进房、推拉流等操作。如果遇到异常，可以将异常信息交给 AI 处理。
场景二：在已有项目中集成 TRTC Web SDK
3.1 依赖安装和组件导入
输入提示词， AI 帮您在已有项目中集成 SDK ，提示词中请务必指定目标文件路径，以提高 AI 操作的准确性（例如：请在 src/views/call.vue 中集成 TRTC Web SDK）。
提示词示例：
请在 src/views/call.vue 中集成 TRTC Web SDK 组件。
3.2 获取登录账号信息
TRTC Web SDK 集成完成后，您需要使用您自己的 SDKAppID 获取临时登录的账号信息。
注意： 开发阶段可以用临时账号信息登陆体验， 不建议在生产环境中使用。在生产环境中，需要部署 userSig 签发服务，在后端生成登陆所需的账号信息。
提示词示例：
请使用 MCP 工具，给我配置的 SDKAppID 的用户 test001 生成一个 userSig。
3.3 填写登录凭据
AI 输出账号信息后，让 AI 自动将所有登录信息填入代码。
提示词示例：
请把 SDKAppID、userID、userSig 填写到代码中。
场景三：集成开发过程中遇到问题
MCP 集成了过去十几年积累的 TRTC 接入过程中遇到的问题和解决方案，通过 AI 可以快速解决开发过程中遇到的问题。
提示词示例：
部署 TRTC Web SDK 服务时常见的问题和最佳实践有哪些？应该避免哪些冗余代码？
步骤4：运行项目
-
AI 会尝试使用项目中配置的启动命令（例如
npm run dev、pnpm run dev）启动项目。 -
如果项目没有自动启动，您可以手动输入启动指令，AI 会自动执行。
常见问题
如何手动安装 MCP server ?
如果您需要手动安装 MCP server, 请在终端执行以下命令：
npx -y @tencentcloud/sdk-mcp
AI 创建项目过程中，如果遇到文件夹访问权限问题，怎么解决?
如果遇到本地目录访问权限问题，建议使用 sudo 权限给目录赋予写权限。
MCP 工具生成的 userSig 登录失败，怎么办 ?
MCP 工具生成的 userSig 登录失败，可能是因为在某些特定 IDE 下自动写入时字符被修改了，您可以让 AI 重新生成或者手动复制 userSig 到代码中。