@tencent-rtc/trtc-agent-skills 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tencent RTC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,172 @@
+# TRTC AI Integration
+
+**English** | [简体中文](README.zh.md)
+
+An agent skill provided by [TRTC](https://trtc.io) (Tencent Real-Time Communication) to help developers integrate real-time audio/video, live streaming, and instant messaging into their apps — from first setup to production-ready code.
+
+Instead of reading through long documentation, you describe what you want to build in plain language. The skill routes your request to the right knowledge, asks a few clarifying questions, and walks you through the integration step by step.
+
+You can use it to build scenarios like video conferencing, live streaming rooms, 1-on-1 video consultations, online classrooms, or customer support chat — across Web, iOS, Android, Flutter, and more.
+
+---
+
+## Installation
+
+**Claude Code**
+
+```bash
+# Step 1 — add the TRTC plugin marketplace
+/plugin marketplace add Tencent-RTC/agent-skills
+
+# Step 2 — install the plugin
+/plugin install trtc-agent-skills@trtc-marketplace
+
+# Step 3 — activate without restarting
+/reload-plugins
+```
+
+**Cursor**
+
+Clone the repo into Cursor's local plugin directory:
+
+```bash
+git clone https://github.com/Tencent-RTC/agent-skills.git ~/.cursor/plugins/local/trtc-agent-skills
+```
+
+Then press **`Cmd+Shift+P`** (Mac) / **`Ctrl+Shift+P`** (Windows/Linux) → `Reload Window` (or restart Cursor).
+
+**Codex CLI**
+
+```bash
+# Step 1 — add the TRTC plugin marketplace
+codex plugin marketplace add Tencent-RTC/agent-skills
+
+# Step 2 — open the plugin browser inside Codex CLI:
+/plugins
+# Select the "TRTC Agent Skills" tab → select trtc-agent-skills → press Enter to install
+```
+
+**CodeBuddy CLI**
+
+```bash
+# Step 1 — add the TRTC plugin marketplace
+/plugin marketplace add Tencent-RTC/agent-skills
+
+# Step 2 — install the plugin
+/plugin install trtc-agent-skills@trtc-marketplace
+
+# Step 3 — activate without restarting
+/reload-plugins
+```
+
+## Using with MCP
+
+This skill is designed to work alongside the [Tencent RTC MCP server](https://trtc.io/document/78382). The skill provides behavioral guidance on how to integrate TRTC, while MCP provides up-to-date API docs and `userSig` generation.
+
+> You can find `YOUR_SDKAPPID` and `YOUR_SECRET_KEY` on the application details page in the [console (International)](https://console.trtc.io) or [console (China)](https://console.cloud.tencent.com).
+
+**Claude Code**
+
+```bash
+claude mcp add tencent-rtc -e SDKAPPID=YOUR_SDKAPPID -e SECRETKEY=YOUR_SECRET_KEY -- npx -y @tencentcloud/sdk-mcp@1.4.3
+```
+
+**Cursor** — add to `.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "tencent-rtc": {
+      "command": "npx",
+      "args": ["-y", "@tencentcloud/sdk-mcp@1.4.3"],
+      "env": {
+        "SDKAPPID": "YOUR_SDKAPPID",
+        "SECRETKEY": "YOUR_SECRET_KEY"
+      }
+    }
+  }
+}
+```
+
+**Codex CLI**
+
+```bash
+codex mcp add tencent-rtc --env SDKAPPID=YOUR_SDKAPPID --env SECRETKEY=YOUR_SECRET_KEY -- npx -y @tencentcloud/sdk-mcp@1.4.3
+```
+
+**CodeBuddy** — add via Settings → Add MCP:
+
+```json
+{
+  "mcpServers": {
+    "tencent-rtc": {
+      "command": "npx",
+      "args": ["-y", "@tencentcloud/sdk-mcp@1.4.3"],
+      "env": {
+        "SDKAPPID": "YOUR_SDKAPPID",
+        "SECRETKEY": "YOUR_SECRET_KEY"
+      }
+    }
+  }
+}
+```
+
+---
+
+## What it does
+
+The skill activates automatically when you mention TRTC or describe a real-time communication use case. No slash commands needed — just ask in plain language.
+
+| | What it does | Example prompts |
+|---|---|---|
+| **Get started** | Guides you through demo setup, SDK integration, troubleshooting, or adding a new feature — step by step | • *"I want to add video conferencing to my web app"*<br>• *"I'm getting error 6206 when users join"*<br>• *"Conference is working — now I want to add screen sharing"* |
+| **Scenario walkthrough** | Loads a complete feature scenario and walks you through each capability in order, with code and checkpoints | • *"Walk me through building a complete conference room from scratch"*<br>• *"Guide me through a 1-on-1 video consultation end to end"* |
+| **Docs & lookup** | Answers factual questions from the official knowledge base with cited sources | • *"What does error code 6206 mean?"*<br>• *"How much does Conference cost per participant minute?"*<br>• *"What's the max number of participants?"* |
+
+The skill saves your progress in the project. If you close the tool and come back later, it picks up where you left off.
+
+---
+
+## Supported Products & Platforms
+
+| Product | Description | Availability |
+|---------|-------------|--------------|
+| **Conference** | Video conferencing — multi-party meetings, screen sharing, in-meeting chat | Web ✅ |
+| **Live** | Interactive live streaming — anchor/audience roles, co-hosting, barrage, gifts, beauty filters | Coming soon |
+| **Chat** | Instant messaging — messages, conversations, groups, user profiles | Coming soon |
+| **Call** | Audio/video calling — 1-on-1 and group calls | Coming soon |
+| **RTC Engine** | Low-level real-time audio/video engine — room management, publishing, subscribing | Coming soon |
+
+
+---
+
+## How It Works
+
+When you describe what you want to build, the skill:
+
+- **Identifies** your TRTC product and platform — from your message or by reading your project files
+- **Asks** what you're trying to do: run a demo, start a new integration, troubleshoot an error, or add a feature to an existing project
+- For integrations, **picks a scenario** from the knowledge base that matches your use case and shows you the full capability list — what will be implemented, in what order — before starting
+- **Walks through** one capability at a time with production-ready code, waits for you to confirm it works, then moves to the next step
+- **Saves your progress** to `.trtc-session.yaml` in your project root (auto-added to `.gitignore`) so you can resume in a later session without re-explaining what you're building
+
+Step-by-step integration is currently available for **Conference on Web**. Docs lookup, error code search, and pricing questions work across all TRTC products (Conference, Live, Chat, Call, RTC Engine).
+
+### Knowledge base: Slices and Scenarios
+
+The skill's knowledge is structured into two layers:
+
+**Slices** are atomic capability units — one slice per feature, such as `conference/join-room`, `conference/screen-share`, or `live/barrage`. Each slice has two levels:
+- A product-level overview (concepts, best practices, troubleshooting, cross-platform notes)
+- A platform-level implementation (exact APIs, code samples, platform-specific gotchas)
+
+**Scenarios** are curated sequences of slices for complete use cases. For example, the *Conference Room* scenario chains multiple slices — from authentication and room creation through screen sharing, member management, and cleanup — in the order a real implementation would follow.
+
+---
+
+## Links
+
+- [TRTC Documentation](https://trtc.io/document)
+- [TRTC Console (International)](https://console.trtc.io)
+- [TRTC Console (China)](https://console.cloud.tencent.com)
+- [Report an issue](https://github.com/Tencent-RTC/agent-skills/issues)

package/README.zh.md

@@ -0,0 +1,173 @@
+# TRTC AI Integration
+
+**[English](README.md)** | 简体中文
+
+由 [TRTC](https://trtc.io)（腾讯实时音视频）提供的 Agent Skill，帮助开发者将实时音视频、直播、即时通信能力集成到应用中——从零开始到可上线的代码。
+
+不需要翻文档，用自然语言描述你要做什么，Skill 会自动匹配对应知识、问几个关键问题，然后一步步带你完成集成。
+
+可以用来构建视频会议、直播间、1v1 视频问诊、在线教室、客服会话等场景，支持 Web、iOS、Android、Flutter 等平台。
+
+---
+
+## 安装
+
+**Claude Code**
+
+```bash
+# 第一步 — 添加 TRTC 插件市场
+/plugin marketplace add Tencent-RTC/agent-skills
+
+# 第二步 — 安装插件
+/plugin install trtc-agent-skills@trtc-marketplace
+
+# 第三步 — 无需重启，直接激活
+/reload-plugins
+```
+
+**Cursor**
+
+克隆仓库并安装到 Cursor 本地插件目录：
+
+```bash
+git clone https://github.com/Tencent-RTC/agent-skills.git ~/.cursor/plugins/local/trtc-agent-skills
+```
+
+然后按 **`Cmd+Shift+P`**（Mac）/ **`Ctrl+Shift+P`**（Windows/Linux）→ 输入 `Reload Window` 回车（或直接重启 Cursor）。
+
+**Codex CLI**
+
+```bash
+# 第一步 — 添加 TRTC 插件市场
+codex plugin marketplace add Tencent-RTC/agent-skills
+
+# 第二步 — 在 Codex CLI 中打开插件浏览器：
+/plugins
+# 选择 "TRTC Agent Skills" 标签页 → 选择 trtc-agent-skills → 按 Enter 安装
+```
+
+**CodeBuddy CLI**
+
+```bash
+# 第一步 — 添加 TRTC 插件市场
+/plugin marketplace add Tencent-RTC/agent-skills
+
+# 第二步 — 安装插件
+/plugin install trtc-agent-skills@trtc-marketplace
+
+# 第三步 — 无需重启，直接激活
+/reload-plugins
+```
+
+## 配置 MCP
+
+本 Skill 需要配合 [Tencent RTC MCP Server](https://trtc.io/document/78382) 使用。Skill 负责集成引导，MCP 负责提供最新 API 文档和生成测试用 `userSig`。
+
+> YOUR_SDKAPPID 和 YOUR_SECRET_KEY 可在[控制台（国际站）](https://console.trtc.io)/[控制台（中国站）](https://console.cloud.tencent.com)的应用详情页获取。
+
+**Claude Code**
+
+```bash
+claude mcp add tencent-rtc -e SDKAPPID=YOUR_SDKAPPID -e SECRETKEY=YOUR_SECRET_KEY -- npx -y @tencentcloud/sdk-mcp@1.4.3
+```
+
+**Cursor** — 添加到 `.cursor/mcp.json`：
+
+```json
+{
+  "mcpServers": {
+    "tencent-rtc": {
+      "command": "npx",
+      "args": ["-y", "@tencentcloud/sdk-mcp@1.4.3"],
+      "env": {
+        "SDKAPPID": "YOUR_SDKAPPID",
+        "SECRETKEY": "YOUR_SECRET_KEY"
+      }
+    }
+  }
+}
+```
+
+**Codex CLI**
+
+```bash
+codex mcp add tencent-rtc --env SDKAPPID=YOUR_SDKAPPID --env SECRETKEY=YOUR_SECRET_KEY -- npx -y @tencentcloud/sdk-mcp@1.4.3
+```
+
+**CodeBuddy** — 通过 设置 → 添加 MCP 配置：
+
+```json
+{
+  "mcpServers": {
+    "tencent-rtc": {
+      "command": "npx",
+      "args": ["-y", "@tencentcloud/sdk-mcp@1.4.3"],
+      "env": {
+        "SDKAPPID": "YOUR_SDKAPPID",
+        "SECRETKEY": "YOUR_SECRET_KEY"
+      }
+    }
+  }
+}
+```
+
+---
+
+## 能做什么
+
+当你提到 TRTC 或描述一个实时通信场景时，Skill 会自动触发，无需任何斜杠命令，直接用自然语言提问即可。
+
+| | 功能说明 | 示例 |
+|---|---|---|
+| **快速上手** | 引导你跑通 Demo、从零集成、排查错误或添加新功能 | *"我想在 Web 应用里加视频会议"* · *"用户进房报错 6206"* · *"会议已接入，现在想加屏幕共享"* |
+| **场景引导** | 加载完整场景，按顺序逐步实现每个能力，每步附代码和验证 | *"我想搭建一个会议应用"* · *"我想用 Conference 搭建一个医疗问诊场景"* |
+| **文档查询** | 从官方知识库检索事实性问题，每个答案附来源引用 | *"错误码 6206 是什么意思？"* · *"Conference 按分钟怎么计费？"* · *"会议室最多支持多少人？"* |
+
+Skill 会在项目中保存你的进度。关掉工具下次回来，可以从上次中断的地方继续，不需要重新复述你在做什么。
+
+---
+
+## 支持的产品与平台
+
+| 产品 | 说明 | 可用状态 |
+|------|------|---------|
+| **Conference** | 视频会议——多人会议、屏幕共享、会中聊天 | Web ✅ |
+| **Live** | 互动直播——主播/观众、连麦、弹幕、礼物、美颜 | 即将支持 |
+| **Chat** | 即时通信——消息、会话、群组、用户资料 | 即将支持 |
+| **Call** | 音视频通话——1v1 和群组通话 | 即将支持 |
+| **RTC Engine** | 实时音视频引擎——进房、推流、拉流 | 即将支持 |
+
+
+---
+
+## 工作原理
+
+当你描述要做什么时，Skill 会：
+
+- **识别**你的 TRTC 产品和平台——从你的描述或项目文件中推断
+- **询问**你的意图：跑通 Demo、从零集成、排查错误，还是在已有项目上扩展功能
+- 对于集成任务，从知识库**匹配场景**，展示完整的能力清单——要实现什么、按什么顺序——确认后再开始
+- **逐步推进**，每次只处理一个能力，给出可用代码，等你确认成功后再继续
+- **保存进度**到项目根目录的 `.trtc-session.yaml`（自动加入 `.gitignore`），支持跨 session 续接
+
+集成引导目前仅支持 **Conference Web**。文档查询、错误码搜索、计费咨询全产品可用（Conference、Live、Chat、Call、RTC Engine）。
+
+### 知识库：Slice 与 Scenario
+
+Skill 的知识分两层：
+
+**Slice** 是原子能力单元——每个功能对应一个 Slice，如 `conference/join-room`、`conference/screen-share`、`live/barrage`。每个 Slice 分两层：
+- 产品级概览：功能说明、核心概念、最佳实践、排障指南（跨平台通用）
+- 平台实现细节：具体 API、代码示例、平台特有注意事项
+
+**Scenario** 是面向完整场景的 Slice 串联。例如「会议室」Scenario 按顺序链接多个 Slice——从鉴权、创建房间，到屏幕共享、成员管理、退出清理——以真实集成顺序排列。
+
+---
+
+## 相关链接
+
+- [TRTC 文档](https://trtc.io/document)
+- [控制台（国际站）](https://console.trtc.io)
+- [控制台（中国站）](https://console.cloud.tencent.com)
+- [下载 SDK](https://trtc.io/download)
+- [提交问题](https://github.com/Tencent-RTC/agent-skills/issues)