> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stmlink.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> 对外开放的服务端接口有两组前缀，都用同一套鉴权：`/server/v1/...`（SRTC 与 SMeeting 的主接口）和 `/stm/srvapi/v1/...`（SMeeting 的用户体系，服务端极简对接会用到）。鉴权是 app_id + nonce + timestamp + signature 四个请求头，用 app_key 做 HMAC-SHA256 签名，只能从业务方自己的后端调用。除这两组前缀外的接口均为内部接口，不要建议客户调用。
> app_key 是服务端密钥，绝不能出现在客户端代码、前端配置或移动 App 里。客户端加入频道用的 token 必须由业务方后端签发后下发（SRTC 走 `/server/v1/channel/grant`，SMeeting 走 `/stm/srvapi/v1/member/grant`）。
> SRTC 与 SMeeting 是上下两层不同的产品，术语不通用：SRTC 是音视频底座，说「频道 channel」「加入 / 退出」；SMeeting 建在 SRTC 之上，说「房间 room」「会议 meeting」「进入 / 退出」。回答时按用户所在的层用对应术语，不要把「房间」「会议」安到 SRTC 的接口上。
> 同一能力在各端 SDK 里的包名、类名、方法名并不相同。写示例代码时请使用文档中该端自己的 API，不要把一个端的写法套到另一个端上。苹果平台每个产品都有两套 SDK（Swift 原生与 Objective-C），两套 API 不能混用。

# 用 AI 辅助接入

> 把 SRTC / SMeeting 文档接进 Claude Code、Cursor 等 AI 编程工具：一条命令安装能力说明，或接入文档 MCP 服务

如果你用 AI 编程工具写代码，可以把我们的文档接进去，让它按我们的接口和约定生成代码，而不是凭训练数据猜。

两种方式，**推荐第一种**，一条命令搞定。

***

## 方式一：安装能力说明（推荐）

在你的项目目录下执行：

```bash theme={null}
npx skills add https://docs.stmlink.com
```

装完会在项目里生成 `.agents/skills/`，支持 Claude Code、Cursor、Codex、Gemini CLI、Devin 等主流工具，你的 AI 会自动读取。

装进去的是三份按场景拆分的能力说明：

| 名称                        | 什么时候会被用到                     |
| ------------------------- | ---------------------------- |
| **SRTC 音视频接入**            | 做实时音视频：加入频道、发布订阅轨道、屏幕共享、录制   |
| **SMeeting 会议接入**         | 做视频会议：选对接方式、会控、举手、等候室、会中消息   |
| **SRTC / SMeeting 服务端接入** | 后端调接口：签名怎么算、Token 怎么签发、回调怎么接 |

它们不是文档的复制品，而是**接入时最容易踩坑的地方**：调用顺序、两层术语的区别、签名失败的三个常见原因、哪些设计我们做不到（比如主持人不能强开别人摄像头）。

<Tip>
  装完可以直接问："我要做一个带主持人和举手的视频会议，用 Web，帮我规划一下接入方案。"
  AI 会先判断该用哪种对接方式，再给步骤——而不是直接堆一段可能用错层的代码。
</Tip>

***

## 方式二：接入文档 MCP 服务

需要 AI 实时查阅完整文档（而不只是能力说明）时，配置我们的 MCP 服务：

```
https://docs.stmlink.com/mcp
```

它提供文档搜索和按路径读取整页的能力，配置方式参考你所用工具的 MCP 文档。连上之后，上面那三份能力说明也会被自动发现，不用重复安装。

***

## 给 AI 单独喂上下文

不想装任何东西，也可以直接把这些地址给 AI：

| 地址                                  | 内容                                             |
| ----------------------------------- | ---------------------------------------------- |
| `https://docs.stmlink.com/llms.txt` | 全站页面目录，按产品和平台分好组，AI 据此决定读哪页                    |
| 任意文档页 URL 加 `.md`                   | 该页的 Markdown 原文，例如 `/zh/rtc/web/quickstart.md` |

每个页面右上角也有「复制」和「在 ChatGPT / Claude 中打开」按钮。

***

## 效果取决于你怎么问

这几点能明显提高生成质量：

* **说清楚是哪一层。** "用 SMeeting 做会议"和"用 SRTC 做音视频通话"走的是完全不同的接口，术语也不通用。
* **说清楚端。** 同一能力在 Web、Android、Swift 上的类名方法名都不一样。
* **说清楚要不要自己做界面。** 这决定了 SMeeting 该用哪种对接方式，选错会白做很多工作。

<Warning>
  **AI 生成的代码需要你复核，尤其是密钥相关的部分。** `app_key` 只能待在你自己的后端，
  任何把它写进前端代码、配置文件或移动 App 的方案都是错的——即便 AI 这么生成了。
  见 [Token 与鉴权](/zh/rtc/token)。
</Warning>

***

## 遇到问题

如果 AI 生成的代码用错了接口，通常说明文档在那一块讲得不够清楚。欢迎把情况反馈给我们，我们会改文档——这比你单独绕过去更有价值。