You need to enable JavaScript to run this app.
文档中心
实时音视频

实时音视频

复制全文
下载 pdf
通过 AI 使用
通过 MCP
复制全文
下载 pdf
通过 MCP
AI 工具(如 TRAE Work、AI IDE、命令行助手等)可以通过 RTC 文档 MCP 搜索和读取 RTC 文档,包括 AI 音视频互动方案、实时信令等内容,用于代码生成、错误排查和异常定位等。​
连接 MCP​
通过 Skill 连接 MCP​
如果您的 AI 工具支持 Skill 或自定义 Agent 指令,推荐优先添加 RTC 文档 MCP Skill。Skill 会把 MCP 端点、工具调用方式和文档搜索策略封装给 Agent,用户无需手动理解 MCP 配置细节,也能让 Agent 在回答前更准确地搜索、读取和引用 RTC 官方文档。​
在您的 AI 工具中添加以下 Skill:​
点击展开 Skill​
​
---​
name: "rtc-docs"​
description: "查询 RTC 文档站的产品说明、操作指南和 OpenAPI 文档。用户询问火山引擎 RTC、AI 音视频互动方案、实时对话式 AI、硬件对话智能体、实时信令、SDK/API 参考、接入步骤、API 参数、请求示例、错误码或故障排查时使用。"​
---​
​
# RTC 文档站​
​
## MCP 端点​
​
```text​
https://topic.bytedance.com/mcp/rtc​
```​
​
该端点支持通过 HTTP 调用 MCP 工具。调用时必须满足:​
​
+ 使用 `POST` 请求。​
+ 请求头 `Content-Type` 使用 `application/json`。​
+ 请求头 `Accept` 使用 `application/json, text/event-stream`。​
+ `User-Agent` 必须填写当前 Agent 名称或者模型名称,例如 `gpt-5.6-sol`。​
+ 当前服务支持无会话调用,无需 initialize,不需要保存或传递 `Mcp-Session-Id`。​
​
执行下面的示例前,将 `MODEL_NAME` 修改为当前 Agent 名称或者模型名称:​
​
```bash​
MODEL_NAME='gpt-5.6-sol'​
```​
​
## 按关键词搜索文档:`search_docs`​
​
根据用户的问题提取关键词并搜索文档。返回结果为 JSON 字符串,主要字段包括 `id`、`title`、`keywords`、`summary`、`highlight` 和 `score`。​
​
优先搜索用户问题中的精确词,例如 API 名称、SDK 类名、事件名、错误码、报错原文、参数名和产品功能名。​
​
```bash​
curl -sS "https://topic.bytedance.com/mcp/rtc" \​
-H "Content-Type: application/json" \​
-H "Accept: application/json, text/event-stream" \​
-H "User-Agent: ${MODEL_NAME}" \​
--data-raw '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"search_docs","arguments":{"query":"搜索关键词或用户问题"}}}'​
```​
​
## 获取文档索引:`list_docs`​
​
在搜索结果不足、用户意图模糊、需要浏览目录、或需要确认产品分类时,读取文档索引。相关参数:​
​
+ `line_offset`:可选,整数,默认值为 `0`,表示过滤后跳过的行数。​
+ `line_limit`:可选,整数,默认值为 `200`,表示本次最多返回的行数。​
+ `grep`:可选,字符串,按行过滤索引并忽略大小写,多个关键词使用 `|` 分隔,按或关系匹配。​
​
返回结果为 JSON 字符串,主要内容为 Markdown 格式的文档索引,每项包含目录、标题、文档 ID 和摘要。​
​
```bash​
curl -sS "https://topic.bytedance.com/mcp/rtc" \​
-H "Content-Type: application/json" \​
-H "Accept: application/json, text/event-stream" \​
-H "User-Agent: ${MODEL_NAME}" \​
--data-raw '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"list_docs","arguments":{}}}'​
```​
​
## 获取文档正文:`fetch_doc`​
​
文档 ID 必须来自 `search_docs` 或 `list_docs`。​
​
优先搜索,再根据返回的文档 ID 获取完整正文。回答 API 参数、请求示例、接入步骤、错误原因或排查建议前,必须先读取最相关文档的正文。仅根据正文回答,不要猜测文档未说明的信息。相关参数:​
​
+ `id`:必填,字符串,由 `search_docs` 或 `list_docs` 返回的文档 ID。​
+ `line_offset`:可选,整数,默认值为 `0`,表示跳过的正文行数。​
+ `line_limit`:可选,整数,默认值为 `200`,表示本次最多返回的正文行数。​
​
```bash​
curl -sS "https://topic.bytedance.com/mcp/rtc" \​
-H "Content-Type: application/json" \​
-H "Accept: application/json, text/event-stream" \​
-H "User-Agent: ${MODEL_NAME}" \​
--data-raw '{"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"fetch_doc","arguments":{"id":"文档 ID"}}}'​
```​
​
## 搜索和回答规则​
​
1. 先判断用户询问的产品范围:实时音视频、AI 音视频互动方案、实时对话式 AI、硬件对话智能体、实时信令或互动白板。​
2. 再判断平台或接口面:Web、Android、iOS、Electron、Flutter、Windows、macOS、Linux、OpenAPI、服务端回调或控制台操作。​
3. API 问题优先搜索精确 API 名称和接口版本,例如 `StartVoiceChat`、`StopVoiceChat`、`UpdateVoiceChat`,再搜索相关参数名。​
4. 错误排查优先搜索精确错误码或报错原文,再搜索相关 API、事件或 SDK 模块。​
5. SDK 行为问题必须确认平台和 SDK 版本;缺少这些信息且会影响答案时,先问一个简短澄清问题。​
6. 如果搜索结果不准,换用同义关键词、英文 API 名称、产品目录名或错误码再次搜索;仍不明确时调用 `list_docs` 浏览目录。​
7. 如果多篇文档存在冲突,优先采用最新版本 API 参考、发版说明或产品专项指南,并在回答中说明不确定点。​
8. 回答时说明参考的文档标题或章节;不要编造链接、参数名、枚举值、控制台路径或错误原因。​
​
​
​
直接连接 MCP​
如果您的 AI 工具原生支持 MCP 配置,也可以直接连接 RTC 文档 MCP Server。​
​
TRAE
Cursor 或 Windsurf
Claude Code
VS Code
​
在 TRAE 的 设置 > MCP 中手动添加以下配置:​
​
{​
"mcpServers": {​
"rtc-docs": {​
"type": "http",​
"url": "https://topic.bytedance.com/mcp/rtc"​
}​
}​
}​
​
​
MCP 工具列表​
  • search_docs:搜索相关文档​
  • list_docs:获取文档列表​
  • fetch_doc:读取指定文档的完整内容​
使用示例​
以下示例以 AI 音视频互动方案为主。使用 Skill 时,AI 会按 Skill 中的 MCP 调用方式和搜索规则读取官方文档,再输出结论;使用 MCP 配置时,AI 可以直接调用文档搜索和全文读取工具。​
示例一:查询文档​
​
获取“接入端到端实时语音大模型”的文档,并总结接入步骤。​
​
示例二:生成配置示例​
​
请先查询 AI 音视频互动方案中 “Function Calling”的文档,再给出一个可参考的工具定义和调用流程。​
​
示例三:错误或异常查询​
​
调用 StartVoiceChat 接口报错 “NoPermissionForApp”?​
​
​
最近更新时间:2026.08.20 16:06:00
这个页面对您有帮助吗?
有用
有用
无用
无用