description: "查询 RTC 文档站的产品说明、操作指南和 OpenAPI 文档。用户询问火山引擎 RTC、AI 音视频互动方案、实时对话式 AI、硬件对话智能体、实时信令、SDK/API 参考、接入步骤、API 参数、请求示例、错误码或故障排查时使用。"
https://topic.bytedance.com/mcp/rtc
该端点支持通过 HTTP 调用 MCP 工具。调用时必须满足:
+ 请求头 `Content-Type` 使用 `application/json`。
+ 请求头 `Accept` 使用 `application/json, text/event-stream`。
+ `User-Agent` 必须填写当前 Agent 名称或者模型名称,例如 `gpt-5.6-sol`。
+ 当前服务支持无会话调用,无需 initialize,不需要保存或传递 `Mcp-Session-Id`。
执行下面的示例前,将 `MODEL_NAME` 修改为当前 Agent 名称或者模型名称:
MODEL_NAME='gpt-5.6-sol'
## 按关键词搜索文档:`search_docs`
根据用户的问题提取关键词并搜索文档。返回结果为 JSON 字符串,主要字段包括 `id`、`title`、`keywords`、`summary`、`highlight` 和 `score`。
优先搜索用户问题中的精确词,例如 API 名称、SDK 类名、事件名、错误码、报错原文、参数名和产品功能名。
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":"搜索关键词或用户问题"}}}'
在搜索结果不足、用户意图模糊、需要浏览目录、或需要确认产品分类时,读取文档索引。相关参数:
+ `line_offset`:可选,整数,默认值为 `0`,表示过滤后跳过的行数。
+ `line_limit`:可选,整数,默认值为 `200`,表示本次最多返回的行数。
+ `grep`:可选,字符串,按行过滤索引并忽略大小写,多个关键词使用 `|` 分隔,按或关系匹配。
返回结果为 JSON 字符串,主要内容为 Markdown 格式的文档索引,每项包含目录、标题、文档 ID 和摘要。
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":{}}}'
文档 ID 必须来自 `search_docs` 或 `list_docs`。
优先搜索,再根据返回的文档 ID 获取完整正文。回答 API 参数、请求示例、接入步骤、错误原因或排查建议前,必须先读取最相关文档的正文。仅根据正文回答,不要猜测文档未说明的信息。相关参数:
+ `id`:必填,字符串,由 `search_docs` 或 `list_docs` 返回的文档 ID。
+ `line_offset`:可选,整数,默认值为 `0`,表示跳过的正文行数。
+ `line_limit`:可选,整数,默认值为 `200`,表示本次最多返回的正文行数。
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. 回答时说明参考的文档标题或章节;不要编造链接、参数名、枚举值、控制台路径或错误原因。