@tencent-rtc/mcp 1.3.0 → 1.3.2

package/resource/doc/roomkit/vue/workflow.md

@@ -0,0 +1,487 @@
+# Vue TUIRoomKit (Atomicx Version) Code Generation Workflow Instructions
+
+## 📋 Instruction Purpose
+
+Provide Agents with a **code generation blueprint for implementing Vue TUIRoomKit (Atomicx version) core features**, and guide Agents to **prioritize using real-time documentation content obtained from tools**, specifically for PC-side Vue3 audio/video meeting application scenarios.
+
+---
+
+## 🛑 Agent Execution Hard Constraints (Guardrails)
+
+Agents must strictly follow these instructions when generating code:
+
+### 1. Documentation-Driven Integration
+- Must strictly follow the steps in `llm_code_generation_instructions_md` from the tool return results
+- **Must strictly generate code according to example code in integration documentation**, do not modify code structure and implementation methods without authorization
+- Code generation should fully follow best practices and examples provided in integration documentation to ensure code correctness and runnability
+
+### 2. Source Code Integration Method
+- TUIRoomKit (Atomicx version) uses **source code integration method**, requires cloning from GitHub and copying core source code files
+- Must follow documentation guidance to copy specified source code folders (assets, components, hooks, i18n, utils, config, views) to user project
+- When copying, must ensure merging with existing folders in user project, avoid direct overwriting
+
+### 3. Silent Integration Execution
+- After all code is written, automatically install dependencies and start project in the final step
+- After successful startup, prompt user to access local development server address in browser
+
+### 4. Zero External Configuration (Testing Phase)
+- Prohibit automatically creating any `.env` files for production environment configuration
+- Critical credentials such as SDKAppID and SDKSecretKey must be read from MCP environment variables and directly configured in `src/config/basic-info-config.js`
+
+### 5. Authentication Credential Configuration
+- Read `SDKAppID` and `SDKSecretKey` from MCP environment variables, prohibit requiring user manual input
+- UserID generation should be kept simple (can use random number generation, such as `user_${Math.ceil(Math.random()*999)}`)
+- **⚠️ Important Security Warning**: Must inform users that client-side UserSig generation is only suitable for local testing, production environment must generate UserSig on server side
+
+### 6. Vue 3 Composition API
+- Prioritize using `<script setup lang="ts">` syntax (note enabling TypeScript)
+- Use Vue 3 Composition API (ref, reactive, computed, onMounted, etc.)
+- Correctly import and use TUIRoomKit Atomicx components
+
+### 7. Route Configuration
+- Must configure Vue Router, map `home.vue` to homepage (path: `/home`), map `room.vue` to meeting room page (path: `/room`)
+- Default root path redirects to `/home`
+
+### 8. Environment Dependency Preparation
+- Ensure user project supports TypeScript and SCSS, if not installed need to automatically install `typescript` and `sass` development dependencies
+
+---
+
+## 📦 TUIRoomKit Version & Dependency Automation
+
+After Agent generates code, must automatically execute the following dependency chain:
+
+### 1. Core Dependency Version Recommendations
+
+```json
+{
+  "tuikit-atomicx-vue3": "latest",                        // TUIRoomKit atomized component library (includes all Hooks and UI components, will automatically install tuiroom-engine-js)
+  "@tencentcloud/uikit-base-component-vue3": "latest",    // Base UI component library (buttons, input boxes and other common components)
+  "@tencentcloud/tuiroom-engine-js": "latest",            // TRTC audio/video engine SDK (underlying capabilities)
+  "vue-router": "^4.0.0"                                   // Vue Router (for page navigation)
+}
+```
+
+**Dependency Description**:
+
+| Dependency Package | Purpose | Manual Installation Required | Description |
+|-------|------|----------------|------|
+| **tuikit-atomicx-vue3** | TUIRoomKit core package | ✅ Required | Contains all atomized Hooks (useLoginState, useRoomState, useDeviceState, etc.) and atomized UI components (RoomLayoutView, ParticipantViewUI, etc.). Will automatically install `@tencentcloud/tuiroom-engine-js` as dependency |
+| **@tencentcloud/uikit-base-component-vue3** | Base UI component library | ✅ Required | Provides common buttons, input boxes, dialogs and other base components, used internally by TUIRoomKit atomized components |
+| **@tencentcloud/tuiroom-engine-js** | TRTC audio/video engine SDK | ⚠️ Optional | Provides underlying audio/video capabilities (device management, audio/video capture, push/pull stream, etc.). Since `tuikit-atomicx-vue3` will automatically install this dependency, usually no manual installation needed. But if version consistency is required, can manually specify version |
+| **vue-router** | Vue official routing library | ✅ Required | Used to implement route navigation between meeting entry page (`/home`) and meeting room page (`/room`) |
+
+**Dependency Relationships**:
+```
+User Project
+  ├── tuikit-atomicx-vue3 (manual install)
+  │   └── @tencentcloud/tuiroom-engine-js (auto install)
+  ├── @tencentcloud/uikit-base-component-vue3 (manual install)
+  └── vue-router (manual install)
+```
+
+**Best Practices**:
+- ✅ **Recommended**: Only manually install `tuikit-atomicx-vue3`, `@tencentcloud/uikit-base-component-vue3`, `vue-router`, let `@tencentcloud/tuiroom-engine-js` auto-install
+- ⚠️ **Optional**: If precise control of `@tencentcloud/tuiroom-engine-js` version is needed, can manually install and specify version number
+- ❌ **Not Recommended**: Specifying different versions of `@tencentcloud/tuiroom-engine-js` in both `dependencies` and manual installation may cause version conflicts
+
+### 2. Development Environment Dependencies (TypeScript and SCSS)
+
+If user project does not yet support TypeScript and SCSS, Agent must automatically install:
+
+```json
+{
+  "typescript": "latest",  // TypeScript compiler (for type checking and compilation)
+  "sass": "latest"         // SCSS preprocessor (for compiling .scss style files)
+}
+```
+
+**Dependency Description**:
+- **typescript**: TUIRoomKit source code is written in TypeScript, requires TypeScript compiler support
+- **sass**: TUIRoomKit style files are written in SCSS, requires sass preprocessor for compilation
+
+### 3. Build Environment Patch (Vite/esbuild)
+
+If Vite project is detected, Agent must automatically add patch configuration in `package.json` for esbuild-wasm compatibility:
+
+```json
+{
+  "overrides": { 
+    "esbuild": "npm:esbuild-wasm@latest"   // npm uses this field to override dependency version
+  },
+  "resolutions": { 
+    "esbuild": "npm:esbuild-wasm@latest"   // yarn/pnpm uses this field to override dependency version
+  }
+}
+```
+
+**Patch Description**:
+- **Why needed**: In some environments, esbuild native binary may not run properly, using esbuild-wasm (WebAssembly version) can provide better cross-platform compatibility
+- **Applicable scenarios**: Mainly for projects using Vite build tool
+- **Purpose**: Force replace all esbuild versions in project dependencies with esbuild-wasm version
+
+**Installation Command Examples**:
+
+```bash
+# npm
+npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/tuiroom-engine-js vue-router
+npm install typescript sass -D
+
+# pnpm  
+pnpm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/tuiroom-engine-js vue-router
+pnpm install typescript sass -D
+
+# yarn
+yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/tuiroom-engine-js vue-router
+yarn add typescript sass -D
+```
+
+---
+
+## 🏗️ Source Code File Copy Structure
+
+Agent must follow the following structure to copy core source code from sample project to user project:
+
+| Source Path (Sample Project) | Target Path (User Project) | Description |
+|------------------|-------------------|------|
+| `src/assets/` | `src/assets/` | Contains background images, icons and other static resources |
+| `src/components/` | `src/components/` | Contains all TUIRoomKit atomic UI components |
+| `src/hooks/` | `src/hooks/` | Contains TUIRoomKit business logic processing |
+| `src/i18n/` | `src/i18n/` | Contains multi-language configuration files |
+| `src/utils/` | `src/utils/` | Contains common utility functions |
+| `src/config/` | `src/config/` | Contains `basic-info-config.js` and other application configuration information (focus on this file for first-time integration) |
+| `src/views/home.vue` | `src/views/home.vue` | This page contains device detection, room creation/join entry features |
+| `src/views/room.vue` | `src/views/room.vue` | This page is the core meeting interface of TUIRoomKit, integrating complete header, video layout, control bar and sidebar panels |
+
+> **Important Note**: When copying source code files, please ensure **merging** with existing folders in user project, avoid directly overwriting existing folders with same names.
+
+---
+
+## 🎯 TUIRoomKit (Atomicx Version) Core Component Description
+
+When generating code, Agent must understand the core architecture of TUIRoomKit Atomicx:
+
+### Atomized Component Design Philosophy
+
+TUIRoomKit (Atomicx version) adopts atomized component design, developers can flexibly combine these components to build personalized meeting interfaces.
+
+### Core Page Components
+
+| Component Name | Description | Usage Scenario |
+|---------|------|---------|
+| `home.vue` | Meeting entry page | Contains device detection, room creation/join features |
+| `room.vue` | Meeting room core page | Integrates complete header, video layout, control bar and sidebar panels |
+
+### Core Hooks
+
+| Hook Name | Description | Main Purpose |
+|---------|------|---------|
+| `useLoginState` | Login state management | Provides login, setSelfInfo and other methods |
+| `useRoomModal` | Room modal management | Provides handleErrorWithModal error handling method |
+| `useRoomEngine` | Room engine management | Get roomEngine instance |
+
+### Core UI Components (from tuikit-atomicx-vue3)
+
+- **RoomLayoutView**: Video stream layout component (supports grid, sidebar, top bar three layouts)
+- **ParticipantViewUI**: Video stream widget component (customizable)
+- **UIKitProvider**: Global UI configuration component (theme, language)
+
+---
+
+## 🛠️ Detailed Integration Steps
+
+Agent must follow these steps to execute integration:
+
+### Step 1: Clone GitHub Repository and Copy Source Code
+
+```bash
+# Clone TUIRoomKit repository
+git clone https://github.com/Tencent-RTC/TUIRoomKit.git --depth=1
+
+# Enter PC-side Vue3 Atomicx sample directory
+cd TUIRoomKit/Web/example/atomicx-vite-vue3-ts
+
+# Copy core source code files to user project
+# (Note: Need to merge with existing folders in user project, not directly overwrite)
+```
+
+**Agent Execution Notes**:
+- If folders with same names already exist in user project, must perform intelligent merging
+- Must not overwrite user's existing business code
+
+---
+
+### Step 2: Install Project Dependencies
+
+```bash
+# Install core dependencies
+npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/tuiroom-engine-js vue-router
+
+# Install development environment dependencies (if user project does not yet support TypeScript and SCSS)
+npm install typescript sass -S -D
+```
+
+---
+
+### Step 3: Configure Page Routes
+
+Configure or update `src/router/index.ts` file in user project.
+
+**Key Configuration Points**:
+- Configure `/home` route: Map to `home.vue` page (meeting entry)
+- Configure `/room` route: Map to `room.vue` page (meeting room)
+- Default root path `/` redirects to `/home`
+
+**Agent Execution Requirements**:
+- ⚠️ Must strictly generate according to route configuration examples in integration documentation
+- If `src/router/index.ts` file already exists in user project, need to **merge** route configuration into existing code
+- If route not yet configured, need to create new `src/router/index.ts` file
+
+---
+
+### Step 4: Configure App.vue File
+
+Merge configuration content provided in integration documentation into `App.vue` file in user project.
+
+**Key Configuration Points**:
+- Configure global `UIKitProvider` component (set theme and language)
+- Import page router `<router-view />`
+- Execute user login logic (`login` and `setSelfInfo`) in `onMounted` hook
+- Configure global styles to ensure meeting interface displays fullscreen
+
+**Agent Execution Requirements**:
+- ⚠️ Must strictly generate according to `App.vue` example code in integration documentation, do not modify without authorization
+- If user project already has `App.vue` file, need intelligent merging rather than direct overwriting
+
+---
+
+### Step 5: Configure src/main.ts File
+
+Merge route and multi-language configuration provided in integration documentation into entry file `src/main.ts` in user project.
+
+**Key Configuration Points**:
+- Import and register Vue Router
+- Configure multi-language resources (Chinese and English)
+- Mount Vue application
+
+**Agent Execution Requirements**:
+- ⚠️ Must strictly generate according to `main.ts` example code in integration documentation, do not modify without authorization
+- If entry file in user project is `main.js`, need to change file extension to `main.ts`
+- If user project already has route configuration, need intelligent merging rather than direct overwriting
+
+---
+
+### Step 6: Configure Application Information (src/config/basic-info-config.js)
+
+Find `src/config/basic-info-config.js` configuration file in user project directory and perform the following configuration:
+
+**Configuration Method**:
+- Agent must read `SDKAppID` and `SDKSecretKey` from MCP environment variables
+- These credentials are configured in MCP environment, no need to obtain through `get_usersig` tool
+- Directly write values from environment variables into `basic-info-config.js` file
+
+**⚠️ Security Warning**:
+- The Demo example in this document authenticates by configuring `SDKSecretKey` in client-side code, but `SDKSecretKey` can be easily decompiled and reverse engineered. Once key is leaked, attackers can steal your Tencent Cloud traffic
+- **This method is only suitable for local Demo testing and function debugging**
+- **In formal production environment**, recommend generating UserSig on your server side, have your App request dynamic UserSig from business server when UserSig is needed for authentication
+
+**Agent Must Inform Users**:
+> "⚠️ The currently generated code is only suitable for local testing. In formal production environment, you must generate UserSig on server side, see Tencent Cloud documentation: https://cloud.tencent.com/document/product/647/17275#formal"
+
+---
+
+## 🎨 UI Customization Features
+
+TUIRoomKit (Atomicx version) supports flexible UI customization, Agent can provide the following customization solutions according to user needs:
+
+### 1. Theme and Language Configuration
+
+Modify default values for theme and language by configuring `UIKitProvider` parameters in `App.vue`:
+
+| UIKitProvider Parameter | Available Values | Default Value |
+|-------------------|--------|--------|
+| theme | "light" \| "dark" | "light" |
+| language | "zh-CN" \| "en-US" | "en-US" |
+
+```typescript
+<UIKitProvider theme="dark" language="en-US">
+  <router-view />
+</UIKitProvider>
+```
+
+---
+
+### 2. Room Stream Layout Customization
+
+TUIRoomKit currently supports three stream layouts:
+- **Grid Layout** (default): `RoomLayoutTemplate.GridLayout`
+- **Sidebar Layout**: `RoomLayoutTemplate.SidebarLayout`
+- **Top Bar Layout**: `RoomLayoutTemplate.CinemaLayout`
+
+Modify default layout in `src/views/room.vue`:
+
+```typescript
+// Change default video stream layout to sidebar layout
+const participantViewLayout = ref(RoomLayoutTemplate.SidebarLayout);
+
+function handleLayoutUpdate(layout: RoomLayoutTemplate) {
+  participantViewLayout.value = layout;
+}
+```
+
+---
+
+### 3. Custom Video Stream Widget
+
+If you need to customize video stream widget (such as username display, audio/video status icons, etc.), can modify the following component:
+
+```
+src/components/RoomLayoutView/ParticipantViewUI/ParticipantViewUI.vue
+```
+
+---
+
+### 4. Configure User Contact List
+
+TUIRoomKit scheduled meeting user selection list and in-meeting call user selection list default to display user relationship chain list. To batch import user relationship chain, refer to the following steps:
+
+**Step 1**: Use [Account Management > Import Multiple Accounts](https://cloud.tencent.com/document/product/269/4919) REST API interface to batch import user accounts
+
+**Step 2**: Use [Friend Management > Import Friends](https://cloud.tencent.com/document/product/269/8301) REST API interface to batch import user relationship chain
+
+---
+
+## 🔄 Complete Automation Process Summary
+
+```mermaid
+graph TD
+    A[Receive User Requirements] --> B[Clone TUIRoomKit GitHub Repository]
+    B --> C[Copy Core Source Code Files to User Project]
+    C --> D[Install Core Dependencies: tuikit-atomicx-vue3, etc.]
+    D --> E{Detect TypeScript and SCSS Support}
+    E -->|Not Installed| F[Install typescript and sass]
+    E -->|Already Installed| G[Skip]
+    F --> H[Configure Vue Router Routes]
+    G --> H
+    H --> I[Configure App.vue: UIKitProvider + User Login]
+    I --> J[Configure main.ts: Routes + Multi-language]
+    J --> K[Read SDKAppID and SDKSecretKey from MCP Environment Variables]
+    K --> L[Configure basic-info-config.js: SDKAppID + SDKSecretKey]
+    L --> M{User Needs UI Customization?}
+    M -->|Yes| N[Provide UI Customization Solutions: Theme/Layout/Widget]
+    M -->|No| O[Use Default Configuration]
+    N --> P[record_result Record Integration Results]
+    O --> P
+    P --> Q[Automatically Start Development Server: npm run dev]
+    Q --> R[Prompt User to Access Local Development Server Address in Browser]
+```
+
+---
+
+## ✍️ Agent Code Generation Example Instructions (Prompts)
+
+When Agent starts writing code, should follow these semantic logic:
+
+**Basic Integration**:
+> "Follow TUIRoomKit (Atomicx version) source code integration method to generate a Vue 3 audio/video meeting application for me. Please clone repository from GitHub and copy core source code files, automatically configure routes and multi-language, and read SDKAppID and SDKSecretKey from MCP environment variables to configure in `basic-info-config.js`. After startup, prompt me to access debug address in browser. **Please be sure to inform me: The currently generated code is only suitable for local testing, formal production environment must generate UserSig on server side.**"
+
+**Custom Theme and Layout**:
+> "Follow TUIRoomKit (Atomicx version) integration to generate a Vue 3 meeting application. Require dark theme (dark) and English language (en-US), default stream layout is sidebar layout (SidebarLayout)."
+
+**Custom Video Stream Widget**:
+> "Follow TUIRoomKit (Atomicx version) integration to generate a Vue 3 meeting application. Need to customize video stream widget to display custom user information and status icons on video stream."
+
+---
+
+## 📝 Key Points Summary
+
+| Category | Requirement |
+|------|------|
+| **Framework Version** | Specifically for PC-side Vue 3 projects (does not support Vue 2.x and H5) |
+| **Integration Method** | Source code integration (clone from GitHub and copy core source code files) |
+| **Documentation Priority** | Strictly follow latest documentation instructions returned by tools |
+| **Silent Integration** | Automatically install dependencies and start development server after code writing completed |
+| **Credential Injection** | Read credentials from MCP environment variables, configure in `basic-info-config.js` |
+| **Security Warning** | ⚠️ Must inform users: Client-side UserSig generation only suitable for testing, production environment must generate on server side |
+| **Dependency Management** | Automatically install core dependencies and development environment dependencies (TypeScript, SCSS) |
+| **Route Configuration** | Configure two core routes `/home` and `/room` |
+| **Multi-language** | Support Chinese (zh-CN) and English (en-US) |
+| **UI Customization** | Support theme, layout, video stream widget and other customizations |
+
+---
+
+## 🎯 Agent Execution Checklist
+
+After completing code generation, Agent must confirm all the following items:
+
+### Project Initialization
+- [ ] Cloned TUIRoomKit GitHub repository (`git clone https://github.com/Tencent-RTC/TUIRoomKit.git --depth=1`)
+- [ ] Copied core source code files to user project (assets, components, hooks, i18n, utils, config, views)
+- [ ] Installed core dependencies: `tuikit-atomicx-vue3`, `@tencentcloud/uikit-base-component-vue3`, `@tencentcloud/tuiroom-engine-js`, `vue-router`
+- [ ] Detected and installed TypeScript and SCSS development dependencies (if user project not installed)
+
+### Code Generation
+- [ ] Configured Vue Router: `/home` and `/room` routes
+- [ ] Configured `App.vue`: UIKitProvider + user login logic
+- [ ] Configured `main.ts`: routes + multi-language resources
+- [ ] Components use `<script setup lang="ts">` syntax
+
+### Credentials & Login
+- [ ] 🔴 Read SDKAppID and SDKSecretKey from MCP environment variables
+- [ ] Configured SDKAppID and SDKSecretKey in `src/config/basic-info-config.js`
+- [ ] Implemented login() and setSelfInfo() login logic in `App.vue`
+- [ ] ⚠️ **Informed user**: Currently generated code only suitable for local testing, formal production environment must generate UserSig on server side
+
+### UI Configuration
+- [ ] Configured theme (light/dark) and language (zh-CN/en-US) according to user requirements
+- [ ] Configured stream layout (grid/sidebar/top bar) according to user requirements
+- [ ] If user needs custom video stream widget, provided customization solution
+
+### Final Check
+- [ ] Called `record_result` to record integration results
+- [ ] Automatically installed dependencies (npm install)
+- [ ] Automatically started development server (npm run dev)
+- [ ] Prompted user to access local development server address in browser
+- [ ] Project runs normally with no errors
+
+---
+
+## 🔗 Related Tool Reference
+
+### Must Use Tools
+
+#### MCP Environment Variables - Read Authentication Credentials
+**Purpose**: Read Tencent Cloud application credentials from MCP environment variables:
+- `SDKAppID`: Application identifier
+- `SDKSecretKey`: Application secret key
+
+**Usage**:
+- Agent directly reads credentials from MCP environment variables
+- Write credentials to `src/config/basic-info-config.js` file
+- Prohibit letting users manually fill in or obtain from external tools
+
+**Usage Constraints**:
+- ✅ Must read from MCP environment variables
+- ❌ Prohibit letting users manually input
+- ⚠️ Must inform users: Client-side UserSig generation only suitable for testing, production environment must generate on server side
+
+#### `record_result` - Record Integration Results
+**Purpose**: Record integration process and results for statistics and analysis
+
+**Invocation Timing**: Call after completing all integration steps and successfully starting project
+
+---
+
+## 📚 Related Resource Links
+
+- **TUIRoomKit GitHub Repository**: https://github.com/Tencent-RTC/TUIRoomKit
+- **Tencent Cloud TRTC Console**: https://console.cloud.tencent.com/trtc
+- **How to Calculate UserSig in Formal Operation Phase**: https://cloud.tencent.com/document/product/647/17275#formal
+- **URL Domain and Protocol Restrictions**: https://cloud.tencent.com/document/product/647/17249
+- **Dealing with Firewall Restrictions (Intranet Proxy)**: https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-34-advanced-proxy.html
+
+---
+
+**Applicable Framework**: Vue 3 (PC)  
+**TUIRoomKit Version**: tuikit-atomicx-vue3 (Atomicx Version)  
+**Build Tool**: Vite (Recommended)

package/resource/doc/tuicallkit/react/api.md

@@ -1,3 +1,24 @@
+## Important Notice
+
+**Documentation Content Description:**
+- The documentation covers two parts: `TUICallEngine` API and `TUICallKit` UI component API.
+- For `TUICallEngine` API documentation, please refer to **Part One**
+- For `TUICallKit` UI component API documentation, please refer to **Part Two**
+
+---
+
+## Part One: TUICallEngine API Documentation
+
+**TUICallEngine API Overview**
+- When users query `TUICallEngine` API, you must first consult the official TUICallEngine API documentation, then provide correct API usage examples. **Do not speculate on API usage.**
+- Below are the documentation links for each platform. Please access the documentation links directly to obtain API usage:
+  - [TUICallEngine Web API List Documentation](https://trtc.io/document/51016?product=call&menulabel=uikit&platform=web)
+  - [TUICallEngine Web API Usage Examples Documentation](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html)
+
+---
+
+## Part Two: TUICallKit UI Component API Documentation
+
 The TUICallKit API is the **audio and video call component that includes a UI interface**. With the TUICallKit API, you can swiftly develop audio and video call scenarios reminiscent of WeChat through simple interfaces. For further comprehensive steps to access this, please refer to: [Integrating TUICallKit](https://trtc.io/document/50993).
 
 ## API Overview

package/resource/doc/tuicallkit/vue/api.md

@@ -1,3 +1,24 @@
+## Important Notice
+
+**Documentation Content Description:**
+- The documentation covers two parts: `TUICallEngine` API and `TUICallKit` UI component API.
+- For `TUICallEngine` API documentation, please refer to **Part One**
+- For `TUICallKit` UI component API documentation, please refer to **Part Two**
+
+---
+
+## Part One: TUICallEngine API Documentation
+
+**TUICallEngine API Overview**
+- When users query `TUICallEngine` API, you must first consult the official TUICallEngine API documentation, then provide correct API usage examples. **Do not speculate on API usage.**
+- Below are the documentation links for each platform. Please access the documentation links directly to obtain API usage:
+  - [TUICallEngine Web API List Documentation](https://trtc.io/document/51016?product=call&menulabel=uikit&platform=web)
+  - [TUICallEngine Web API Usage Examples Documentation](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html)
+
+---
+
+## Part Two: TUICallKit UI Component API Documentation
+
 The TUICallKit API is the **audio and video call component that includes a UI interface**. With the TUICallKit API, you can swiftly develop audio and video call scenarios reminiscent of WeChat through simple interfaces. For further comprehensive steps to access this, please refer to: [Integrating TUICallKit](https://trtc.io/document/50993).
 
 ## API Overview

package/tools/chat/get-web-chat-integration.js

@@ -2,27 +2,44 @@ import { z } from 'zod';
 import { GET_WEB_CHAT_UIKIT_INTEGRATION_DEFINITION } from '../definitions/get_web_chat_uikit_integration_def.js';
 import { getDocContent } from '../../utils/get-doc-content.js';
 import { reportCLSClient } from '../../utils/report-cls-client.js';
-import { handleFramework } from '../../utils/handle-framework.js';
-function getResultText(params) {
-    const { framework = '' } = params;
+import { generateStructuredResult } from '../../utils/generate-structured-result.js';
+async function getResultText(params) {
+    const { framework = '', goals = [] } = params;
     reportCLSClient({
         method: 'get_web_chat_uikit_integration',
-        framework: framework,
+        info: goals.join(','),
+        framework,
     });
-    return getDocContent(['chatuikit', `${handleFramework(framework)}`, 'integration.md']);
+    // 获取工作流指令
+    const baseInstructions = getDocContent(['chatuikit', framework, 'workflow.md']);
+    // 批量读取目标文档并生成结构化结果
+    const result = await generateStructuredResult({
+        baseInstructions,
+        goals,
+        framework,
+        pathMap: {
+            [goals[0]]: ['chatuikit', framework, 'integration.md'],
+        },
+    });
+    return result;
 }
 const registryGetWebChatIntegrationTool = (mcpServer) => {
     const { name, description, parameter_descriptions } = GET_WEB_CHAT_UIKIT_INTEGRATION_DEFINITION;
     mcpServer.tool(name, description, {
-        framework: z.enum(['react', 'vue']).describe(parameter_descriptions.framework),
-    }, (params) => ({
-        content: [
-            {
-                type: 'text',
-                text: getResultText(params),
-            }
-        ]
-    }));
+        framework: z.enum(['react', 'vue', 'uniapp-app']).describe(parameter_descriptions.framework),
+        goals: z.array(z.enum(['full-featured', 'chat-only'])).describe(parameter_descriptions.goals)
+    }, async (params) => {
+        const result = await getResultText(params);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: result.llm_code_generation_instructions_md,
+                }
+            ],
+            result: result,
+        };
+    });
 };
 export { registryGetWebChatIntegrationTool };
 //# sourceMappingURL=get-web-chat-integration.js.map

package/tools/chat/get-web-chat-integration.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-web-chat-integration.js","sourceRoot":"","sources":["../../../src/tools/chat/get-web-chat-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,yCAAyC,EAAE,MAAM,sDAAsD,CAAC;AACjH,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAClC,eAAe,CAAC;QACd,MAAM,EAAE,gCAAgC;QACxC,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACzF,CAAC;AAED,MAAM,iCAAiC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACjE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,yCAAyC,CAAC;IAChG,SAAS,CAAC,IAAI,CACZ,IAAI,EACJ,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC;KAC/E,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACd,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aAC5B;SACF;KACF,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AACF,OAAO,EAAE,iCAAiC,EAAE,CAAC"}
+{"version":3,"file":"get-web-chat-integration.js","sourceRoot":"","sources":["../../../src/tools/chat/get-web-chat-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,yCAAyC,EAAE,MAAM,sDAAsD,CAAC;AACjH,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AAErF,KAAK,UAAU,aAAa,CAAC,MAA2B;IACtD,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAC9C,eAAe,CAAC;QACd,MAAM,EAAE,gCAAgC;QACxC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QACrB,SAAS;KACV,CAAC,CAAC;IACH,UAAU;IACV,MAAM,gBAAgB,GAAG,aAAa,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;IAChF,mBAAmB;IACnB,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAAC;QAC5C,gBAAgB;QAChB,KAAK;QACL,SAAS;QACT,OAAO,EAAE;YACP,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,gBAAgB,CAAC;SACvD;KACF,CAAC,CAAA;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,iCAAiC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACjE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,yCAAyC,CAAC;IAChG,SAAS,CAAC,IAAI,CACZ,IAAI,EACJ,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC;QAC5F,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC;KAC9F,EACD,KAAK,EAAE,MAAW,EAAE,EAAE;QACpB,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,CAAA;QAC1C,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,CAAC,mCAAmC;iBACjD;aACF;YACD,MAAM,EAAE,MAAM;SACf,CAAA;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EAAE,iCAAiC,EAAE,CAAC"}

package/tools/definitions/get_web_chat_uikit_integration_def.js

@@ -1,22 +1,29 @@
 const TOOL_DESCRIPTION = `
-[CORE FUNCTION]: This is a Web Chat Application Integration Tool, specialized in providing the integration solution for TUIKit components on Web or H5 platforms.\n
+**Core Purpose**: As a professional Web/cross-platform Chat TUIKit integration assistant, this tool provides Agents with workflow action instructions and real-time aggregated latest documentation content to guide LLMs in helping users implement instant messaging (IM) functionality.
 
-[SCOPE]:\n
-1. Builds an instant messaging application with functionality and UI similar to WeChat or WeChat Work, suitable for scenarios like general chat, customer service, or healthcare.\n
-2. Supports UI component libraries for both React and Vue mainstream frameworks.\n
-3. The application entry point can be set on a TabBar as needed, with names including keywords like 'message', 'conversation', or 'information'.\n
+**Functional Goals**:
+1. full-featured: Integrate complete functionality. Includes conversation list, chat window, group management, personal center, etc. **Suitable for building WeChat/WeCom-style complete applications, or as a core Tab module in Apps.**
+2. chat-only: Integrate chat window only. **Suitable for lightweight conversation scenarios such as customer service consultations, online medical consultations, order detail page private chats, etc.**
 
-[KEYWORDS]: 'Web', 'H5', 'Chat Application', 'TUIKit', 'React', 'Vue', 'Integration', 'Instant Messaging', 'Customer Service', 'Healthcare', 'TabBar'.\n
+**Keywords**:
+'Chat', 'TUIKit', 'chat', 'instant messaging', 'WeChat', 'WeCom', 'React', 'Vue', 'uniapp', 'integration', 'customer service', 'medical consultation', 'TabBar', 'message entry', 'conversation list', 'dialog box'.
 
-[MANDATORY CONSTRAINTS]:\n
-1. Framework Selection Constraint: If the user has not explicitly specified the React or Vue framework in the prompt, the tool MUST prioritize calling 'present_framework_choice' to guide the user to make a selection.\n
-2. Result Recording Constraint: After the TUIKit component integration is complete and the project successfully starts, the tool MUST call 'record_result' to log the integration outcome.\n
+**Action Instructions & Workflow Guidance**:
+When handling user requests, the Agent should use the llm_code_generation_instructions_md field returned by this tool. This field contains:
+1. Core workflow instructions: Includes environment preparation, dependency installation, SDK initialization, UserSig authentication, and component version specifications.
+2. Real-time documentation content: Dynamically returns the corresponding official integration guide based on the selected goals.
 
-[NOTES]:\n
-- When integrating the Vue version, please install @tencentcloud/chat-uikit-vue3.
+LLMs MUST prioritize and exclusively use the real-time content returned by this tool to generate code, avoiding accessing external URLs independently.
+
+**Mandatory Constraints**:
+1. Framework Selection Constraint: If the user has not explicitly specified a framework or the intent is unclear, the 'present_framework_choice' tool MUST be called first to guide the user in choosing between react, vue, and uniapp-app.
+2. Result Recording Constraint: After TUIKit component integration is complete and the project starts successfully, the 'record_result' tool MUST be called to record the integration results.
+
+**Supported Frameworks**: react, vue, uniapp-app.
 `;
 const PARAMETER_DESCRIPTIONS = {
-    framework: 'The Web Chat TUIKit framework type. Options: react, vue. Used to determine which framework\'s component integration solution to provide.',
+    framework: 'Chat TUIKit framework type. Available options: react (React Web), vue (Vue3 Web), uniapp-app (Uni-app App/H5).',
+    goals: "List of functional goals requested by the user. Available options: ['full-featured'] (standard application), ['chat-only'] (customer service/consultation/popup).",
 };
 export const GET_WEB_CHAT_UIKIT_INTEGRATION_DEFINITION = {
     name: 'get_web_chat_uikit_integration',

package/tools/definitions/get_web_chat_uikit_integration_def.js.map

@@ -1 +1 @@
-{"version":3,"file":"get_web_chat_uikit_integration_def.js","sourceRoot":"","sources":["../../../src/tools/definitions/get_web_chat_uikit_integration_def.ts"],"names":[],"mappings":"AAAA,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;CAgBxB,CAAC;AAEF,MAAM,sBAAsB,GAAG;IAC7B,SAAS,EAAE,0IAA0I;CACtJ,CAAC;AAEF,MAAM,CAAC,MAAM,yCAAyC,GAAG;IACvD,IAAI,EAAE,gCAAgC;IACtC,WAAW,EAAE,gBAAgB;IAC7B,sBAAsB,EAAE,sBAAsB;CAC/C,CAAC"}
+{"version":3,"file":"get_web_chat_uikit_integration_def.js","sourceRoot":"","sources":["../../../src/tools/definitions/get_web_chat_uikit_integration_def.ts"],"names":[],"mappings":"AAAA,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;;;;;;;CAsBxB,CAAC;AAEF,MAAM,sBAAsB,GAAG;IAC7B,SAAS,EAAE,gHAAgH;IAC3H,KAAK,EAAE,mKAAmK;CAC3K,CAAC;AAEF,MAAM,CAAC,MAAM,yCAAyC,GAAG;IACvD,IAAI,EAAE,gCAAgC;IACtC,WAAW,EAAE,gBAAgB;IAC7B,sBAAsB,EAAE,sBAAsB;CAC/C,CAAC"}