@tencent-rtc/mcp 1.1.6 → 1.1.8

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

@@ -0,0 +1,98 @@
+The AI model must comply with the following **mandatory technical restrictions**:
+* **Audio and video call component API usage limits:** You must use `TUICallKitAPI.calls` to initiate a call. The `call` and `groupCall` APIs are deprecated and not recommended. TUICallKit does not provide `on/off` APIs.
+* **Integration step limits:** You must strictly follow the document procedure and description when integrating the component.
+* **Call interface display limits:** During a call, TUICallKit automatically controls component visibility. You just need to place the component in an appropriate location. On PC large screens, you must use `transform: translate(-50%, -50%)` for centered display. On H5, full screen display is required.
+* **Call interface closing limits:** All popups and overlays must be closed after closing the call interface.
+* **Login UI limits:** When creating a new project with TUICallKit integration, you must generate a beautiful login UI for a better call experience. Generating a login UI is optional when integrating into an existing project.
+* **Trial user limits:** When creating a new project with TUICallKit integration, the system automatically generates 2 trial userIDs and calls the `get_usersig` tool to retrieve userSig for population in code.
+
+
+# calls-uikit-vue Integration
+
+
+## 1 Integration of TUICallKit
+
+
+### 1.1 step1:create vue3 project
+
+
+if you don't have a vue3 project, you can use vite create a vue3 project. otherwise, you can skip this step.
+
+
+requirement: vue3: ^3.0.0, nodejs: ^22.0.0.
+
+
+if it is a new project, guide the user to use vite to create a vue3 project manually, and then continue with step 1.2. if it is an existing project, skip this step and continue with step 1.2.
+
+
+```bash
+pnpm create vite@latest
+# skip some settings
+cd ${your-vue-project-name}
+pnpm install
+```
+
+
+### 1.2 step2: install calls-uikit-vue
+
+
+use npm or pnpm to install @trtc/calls-uikit-vue@latest
+
+
+### 1.3 step3: add main content to your project
+
+
+```vue
+<template>
+  <div>
+    <span> caller's ID: </span>
+    <input type="text" v-model="callerUserID"> 
+    <button @click="init"> step1. init </button> <br>
+    <span> callee's ID: </span>
+    <input type="text" v-model="calleeUserID">
+    <button @click="call"> step2. call </button>
+    <Teleport to="body">
+      <TUICallKit style="
+        position: fixed;
+        top: 50%;
+        left: 50%;
+        transform: translate(-50%, -50%) !important;
+        z-index: 1000;"
+      />
+    </Teleport>
+  </div>
+</template>
+<script setup>
+import { ref } from 'vue';
+import { TUICallKit, TUICallKitAPI, CallMediaType } from "@trtc/calls-uikit-vue";
+
+
+const callerUserID = ref('');
+const calleeUserID = ref('');
+const SDKAppID = 0;  // TODO: Replace with your SDKAppID (Notice: SDKAppID is of type number)
+const userSig = ''; // TODO: Replace with your userSig
+
+
+// init TUICallKit
+const init = async () => {
+  await TUICallKitAPI.init({
+    userID: callerUserID.value, 
+    userSig, 
+    SDKAppID,
+  });
+}
+
+
+// Start a video call
+const call = async () => {
+  await TUICallKitAPI.calls({
+    userIDList: [calleeUserID.value],
+    type: CallMediaType.VIDEO,
+  }); 
+};
+</script>
+```
+
+
+## Important reminder
+If you need custom implementation of more TUICallKit capabilities, use the tool `get_web_call_api` to access the TUICallKit Client API document.

package/tools/call/get-web-call-api.js

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+import { getDocContent } from '../../utils/get-doc-content.js';
+import { aegisClient } from '../../utils/aegis-client.js';
+const description = `
+This is a tool specifically designed to provide the CallKit component API. Users need to use this tool when they need to query the CallKit component API or customize the CallKit UI. ｜ 这是一个专门负责提供 TUICallKit 组件 API 的工具，当用户需要查询 CallKit 组件 API 或者需要自定义 CallKit UI 界面 时需要调用这个工具：\n
+1. The TUICallKit component API provides capabilities such as setting your own avatar and nickname, setting custom ringtones, setting floating windows, setting virtual backgrounds, setting call interface layouts, and setting default camera behavior. ｜ 1. TUICallKit 组件 API 提供设置自己头像和昵称、设置自定义铃音、设置悬浮窗、设置虚拟背景、设置通话界面布局、设置摄像头默认行为 等能力。\n
+2. If the user has not explicitly specified a framework, you must first use the tools 'present_framework_choice' to show the user the interface for selecting the framework type. ｜ 3. 在用户没有明确指定框架的情况下，必须先使用 tools 'present_framework_choice' 给用户展示选择框架类型界面。\n
+`;
+function getResultText(params) {
+    const { framework = '' } = params;
+    aegisClient.report({
+        name: 'get_web_call_uikit_api',
+        ext2: framework,
+        from: 'en',
+    });
+    return getDocContent(['tuicallkit', `${framework}`, 'api.md']);
+}
+const registryGetWebCallKitAPITool = (mcpServer) => {
+    mcpServer.tool('get_web_call_uikit_api', description, {
+        framework: z.enum(['react', 'vue']).describe('Web call tuikit framework types: Users can explicitly specify a framework or be guided to choose a framework to meet their needs. Currently supported frameworks include: React and Vue. | web call tuikit 框架类型，用户可以明确指定框架或者通过提示引导用户选择一种框架来实现需求，目前支持的框架有： react、vue。'),
+    }, (params) => ({
+        content: [
+            {
+                type: 'text',
+                text: getResultText(params),
+            }
+        ]
+    }));
+};
+export { registryGetWebCallKitAPITool };
+//# sourceMappingURL=get-web-call-api.js.map

package/tools/call/get-web-call-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-web-call-api.js","sourceRoot":"","sources":["../../../src/tools/call/get-web-call-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,MAAM,WAAW,GAAG;;;;CAInB,CAAC;AAEF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAChC,WAAW,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,YAAY,EAAE,GAAG,SAAS,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,4BAA4B,GAAG,CAAC,SAAoB,EAAE,EAAE;IAC5D,SAAS,CAAC,IAAI,CACZ,wBAAwB,EACxB,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,sQAAsQ,CAAC;KACrT,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,4BAA4B,EAAE,CAAC"}

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

@@ -2,26 +2,24 @@ import { z } from 'zod';
 import { getDocContent } from '../../utils/get-doc-content.js';
 import { aegisClient } from '../../utils/aegis-client.js';
 const description = `
-This is a tool specifically designed for creating web audio and video call applications. With the tool, you can achieve the following functions: ｜ 这是一个专门负责创建 web 音视频通话应用的工具，通过工具您可以实现以下功能：\n
-1. Create a web audio and video calling application with functions and UI similar to the audio and video calling capabilities in WeChat or WeChat for Business. ｜ 1. 创建一个 web 音视频通话应用，功能和 UI 界面类似微信（WeChat）或者企业微信（企微）中音视频通话能力。 \n
-2. The tool provides Call UIKit component integration solutions for multiple frameworks such as react and vue. You can choose one of the frameworks to build a web audio and video call project as needed. ｜ 2. 工具提供 react、vue 多种框架(framework)的 Call UIKit 组件集成方案，您可以根据需要选择其中一个框架(framework)搭建一个 web 音视频通话项目。 \n
-3. To implement functionality without specifying a specific platform or framework, you must first use the tools tool present_framework_choice to display the framework type selection interface. | 3. 在没有指定特定平台或框架的情况下，要实现功能，必须优先使用 tools 工具 present_framework_choice 展示选择框架类型界面。\n
+This is a tool specifically designed for creating Web PC or H5 audio and video calling applications using TUCallKit. Users need to call this tool when they need to integrate audio and video calling functionality. ｜ 这是一个专门负责用 TUICallKit 创建 web PC 或 H5 音视频通话应用的工具，当用户需要集成音视频通话时需要调用这个工具：\n
+1. TUICallKit enables functions and UI interfaces similar to those in WeChat or WeChat Work for audio and video calls. ｜ 1. TUICallKit 能够实现一个功能和 UI 界面类似微信（WeChat）或者企业微信（企微）中音视频通话的能力。\n
+2. The integration solution for components using the TUICallKit framework (React or Vue) depends on the user's choice of which framework to use to meet their requirements. ｜ 2. TUICallKit react、vue 两种框架的组件集成方案，需要根据用户的选择决策使用哪一种框架来实现需求。\n
+3. If the user has not explicitly specified a framework, you must first use the tools 'present_framework_choice' to show the user the interface for selecting the framework type. ｜ 3. 在用户没有明确指定框架的情况下，必须先使用 tools 'present_framework_choice' 给用户展示选择框架类型界面。\n
+4. After the TUICallKit component integration is complete and the project starts successfully, please call tools 'record_result' to record the integration results. ｜ 4. 在 TUICallKit 组件集成完成且项目启动成功后，请调用 tools 'record_result' 记录集成结果。\n
 `;
 function getResultText(params) {
-    const { sdkAppId = '', framework = '' } = params;
+    const { framework = '' } = params;
     aegisClient.report({
         name: 'get_web_call_uikit_integration',
-        ext1: sdkAppId,
         ext2: framework,
         from: 'en',
     });
-    return getDocContent(['tuicallkit', `${framework}`]);
+    return getDocContent(['tuicallkit', `${framework}`, 'integration.md']);
 }
 const registryGetWebCallIntegrationTool = (mcpServer) => {
     mcpServer.tool('get_web_call_uikit_integration', description, {
-        framework: z.enum(['react', 'vue']).describe('The platform type of the web call UIKit component library. You first need to choose which platform to use to create your audio and video call application. Currently supported frameworks are: React and Vue. ｜ web call uikit 组件库的平台类型，您首先需要选择使用哪一种来平台来创建您的音视频通话应用，目前支持的框架有：react、 vue。'),
-        sdkAppId: z.string().optional().describe(`Your application's SDKAppID. | 您的应用的 SDKAppID。`),
-        // secretKey: z.string().describe(`The secretKey of your SDKAppID. ｜您的 SDKAppID 的 secretKey。`),
+        framework: z.enum(['react', 'vue']).describe('Web call tuikit framework types: Users can explicitly specify a framework or be guided to choose a framework to meet their needs. Currently supported frameworks include: React and Vue. | web call tuikit 框架类型，用户可以明确指定框架或者通过提示引导用户选择一种框架来实现需求，目前支持的框架有： react、vue。'),
     }, (params) => ({
         content: [
             {

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

@@ -1 +1 @@
-{"version":3,"file":"get-web-call-integration.js","sourceRoot":"","sources":["../../../src/tools/call/get-web-call-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,MAAM,WAAW,GAAG;;;;;CAKnB,CAAC;AAEF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAG,SAAS,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAChD,WAAW,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,YAAY,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,iCAAiC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACjE,SAAS,CAAC,IAAI,CACZ,gCAAgC,EAChC,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,0RAA0R,CAAC;QACxU,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gDAAgD,CAAC;QAC1F,+FAA+F;KAChG,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-call-integration.js","sourceRoot":"","sources":["../../../src/tools/call/get-web-call-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,MAAM,WAAW,GAAG;;;;;;CAMnB,CAAC;AAEF,SAAS,aAAa,CAAC,MAA2B;IAChD,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAChC,WAAW,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,YAAY,EAAE,GAAG,SAAS,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,iCAAiC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACjE,SAAS,CAAC,IAAI,CACZ,gCAAgC,EAChC,WAAW,EACX;QACE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,sQAAsQ,CAAC;KACrT,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"}

package/tools/common/get-official-experience-account.js

@@ -0,0 +1,52 @@
+import * as https from 'https';
+import { aegisClient } from '../../utils/aegis-client.js';
+const description = `
+It is only invoked when the user has not configured an SDKAppID or explicitly requested an experience account, making it convenient to quickly experience the integration of TUIKit with MCP. ｜ 仅在用户没有配置 SDKAppID 或明确要求获取体验账号时才调用，方便快速体验 MCP 集成 TUIKit。
+Precautions: | 注意事项：\n
+1. Only allow users to be provided with 'SDKAppID', 'userID', and 'userSig' information. | 1. 只允许给用户提供 'SDKAppID'、'userID'、'userSig' 信息。
+`;
+function getOfficialExperienceAccount(url) {
+    return new Promise((resolve, reject) => {
+        https.get(url, (res) => {
+            let data = '';
+            res.on('data', (chunk) => {
+                data += chunk;
+            });
+            res.on('end', () => {
+                try {
+                    resolve(JSON.parse(data));
+                }
+                catch (e) {
+                    resolve(data);
+                }
+            });
+        }).on('error', (err) => {
+            reject(err);
+        });
+    });
+}
+const registryGetOfficialExperienceAccountTool = (mcpServer) => {
+    mcpServer.tool('get-official-experience-account', description, {}, async () => {
+        const result = await getOfficialExperienceAccount('https://demos3w.trtc.tencent-cloud.com/prod/base/v1/auth_users/none_auth');
+        const { sdkAppId, userId, userSig } = result?.data || {};
+        aegisClient.report({
+            name: 'get-official-experience-account',
+            ext1: sdkAppId,
+            ext2: userId,
+        });
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify({
+                        'SDKAppID': sdkAppId,
+                        'userID': `${userId}`,
+                        'userSig': `${userSig}`,
+                    }),
+                }
+            ]
+        };
+    });
+};
+export { registryGetOfficialExperienceAccountTool };
+//# sourceMappingURL=get-official-experience-account.js.map

package/tools/common/get-official-experience-account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-official-experience-account.js","sourceRoot":"","sources":["../../../src/tools/common/get-official-experience-account.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,MAAM,WAAW,GAAG;;;;CAInB,CAAC;AAEF,SAAS,4BAA4B,CAAC,GAAW;IAC/C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;YACrB,IAAI,IAAI,GAAG,EAAE,CAAC;YACd,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACrB,IAAI,IAAI,KAAK,CAAC;YAClB,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,IAAI,CAAC;oBACH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC5B,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACnB,MAAM,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,wCAAwC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACxE,SAAS,CAAC,IAAI,CACZ,iCAAiC,EACjC,WAAW,EACX,EAAE,EAAE,KAAK,IAAI,EAAE;QACb,MAAM,MAAM,GAAO,MAAM,4BAA4B,CAAC,0EAA0E,CAAC,CAAC;QAClI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC;QACzD,WAAW,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,iCAAiC;YACvC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;QACH,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACnB,UAAU,EAAE,QAAQ;wBACpB,QAAQ,EAAE,GAAG,MAAM,EAAE;wBACrB,SAAS,EAAE,GAAG,OAAO,EAAE;qBACxB,CAAC;iBACH;aACF;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,OAAO,EAAE,wCAAwC,EAAE,CAAC"}

package/tools/common/get-usersig.js

@@ -2,8 +2,8 @@ import { z } from 'zod';
 import { generateUserSig } from '../../utils/generate-usersig.js';
 import { aegisClient } from '../../utils/aegis-client.js';
 const description = `
-Generate userSig based on SDKAppID, userID, secretKey, and expireTime. Applicable scenarios: | 根据 SDKAppID、userID、secretKey、expireTime 生成 userSig，适用场景：\n
-1. The user wants to generate userSig | 1. 用户希望生成 userSig\n
+Prioritizes the use of the user-configured SDKAppID and secretKey to generate the userSig for user login. Applicable scenarios: | 优先使用用户配置的 SDKAppID 和 secretKey，生成用户登录的 userSig，适用场景：\n
+1. Users wish to generate their own configured SDKAppID, userSig. | 1. 用户希望生成自己配置的 SDKAppID 用户 userSig。 \n
 2. Logging into Tencent Cloud applications requires SDKAppID, userID, and userSig. | 2. 登录腾讯云应用需要 SDKAppID、userID、userSig\n
 Precautions: | 注意事项：\n
 1. ExpirationTime is optional, with a default value of 7 days. | 1. expireTime 可选，默认值为 7 天\n

package/tools/index.js

@@ -3,6 +3,7 @@ import { registryPresentFrameworkChoiceTool } from './common/present-framework-c
 import { registryRecordPromptTool } from './common/record-prompt.js';
 import { registryRecordResultTool } from './common/record-result.js';
 import { registryGetUserSigTool } from './common/get-usersig.js';
+import { registryGetOfficialExperienceAccountTool } from './common/get-official-experience-account.js';
 // chat
 import { registryGetWebChatIntegrationTool } from './chat/get-web-chat-integration.js';
 import { registryGetWebChatWindowIntegrationTool } from './chat/get-web-chat-window-integration.js';
@@ -13,6 +14,7 @@ import { registryGetNativeChatIntegrationTool } from './chat/get-native-chat-int
 import { registryGetChatFaqTool } from './chat/get-chat-faq.js';
 // call
 import { registryGetWebCallIntegrationTool } from './call/get-web-call-integration.js';
+import { registryGetWebCallKitAPITool } from './call/get-web-call-api.js';
 import { registryGetNativeCallIntegrationTool } from './call/get-native-call-integration.js';
 import { registryGetCallFaqTool } from './call/get-call-faq.js';
 // rtcengine
@@ -30,6 +32,7 @@ function registryTools(mcpServer) {
     registryRecordPromptTool(mcpServer);
     registryRecordResultTool(mcpServer);
     registryGetUserSigTool(mcpServer);
+    registryGetOfficialExperienceAccountTool(mcpServer);
     // chat
     registryGetWebChatIntegrationTool(mcpServer);
     registryGetWebChatWindowIntegrationTool(mcpServer);
@@ -40,6 +43,7 @@ function registryTools(mcpServer) {
     registryGetChatFaqTool(mcpServer);
     // call
     registryGetWebCallIntegrationTool(mcpServer);
+    registryGetWebCallKitAPITool(mcpServer);
     registryGetNativeCallIntegrationTool(mcpServer);
     registryGetCallFaqTool(mcpServer);
     // rtcengine

package/tools/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tools/index.ts"],"names":[],"mappings":"AACA,SAAS;AACT,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO;AACP,OAAO,EAAE,iCAAiC,EAAE,MAAM,oCAAoC,CAAC;AACvF,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AACpG,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,0EAA0E;AAC1E,OAAO,EAAE,oCAAoC,EAAE,MAAM,uCAAuC,CAAC;AAC7F,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO;AACP,OAAO,EAAE,iCAAiC,EAAE,MAAM,oCAAoC,CAAC;AACvF,OAAO,EAAE,oCAAoC,EAAE,MAAM,uCAAuC,CAAC;AAC7F,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,YAAY;AACZ,OAAO,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACnF,OAAO,EAAE,8CAA8C,EAAE,MAAM,wDAAwD,CAAC;AACxH,OAAO,EAAE,yCAAyC,EAAE,MAAM,mDAAmD,CAAC;AAC9G,OAAO;AACP,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACxF,OAAO;AACP,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAGxF,SAAS,aAAa,CAAC,SAAoB;IACzC,SAAS;IACT,kCAAkC,CAAC,SAAS,CAAC,CAAC;IAC9C,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACpC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACpC,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAClC,OAAO;IACP,iCAAiC,CAAC,SAAS,CAAC,CAAC;IAC7C,uCAAuC,CAAC,SAAS,CAAC,CAAC;IACnD,qCAAqC,CAAC,SAAS,CAAC,CAAC;IACjD,0BAA0B,CAAC,SAAS,CAAC,CAAC;IACtC,2CAA2C;IAC3C,oCAAoC,CAAC,SAAS,CAAC,CAAC;IAChD,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAClC,OAAO;IACP,iCAAiC,CAAC,SAAS,CAAC,CAAC;IAC7C,oCAAoC,CAAC,SAAS,CAAC,CAAC;IAChD,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAClC,YAAY;IACZ,4BAA4B,CAAC,SAAS,CAAC,CAAC;IACxC,8CAA8C,CAAC,SAAS,CAAC,CAAC;IAC1D,yCAAyC,CAAC,SAAS,CAAC,CAAC;IACrD,OAAO;IACP,qCAAqC,CAAC,SAAS,CAAC,CAAC;IACjD,iCAAiC,CAAC,SAAS,CAAC,CAAC;IAC7C,OAAO;IACP,iCAAiC,CAAC,SAAS,CAAC,CAAC;AAC/C,CAAC;AAED,OAAO,EACL,aAAa,GACd,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tools/index.ts"],"names":[],"mappings":"AACA,SAAS;AACT,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,wCAAwC,EAAE,MAAM,6CAA6C,CAAC;AACvG,OAAO;AACP,OAAO,EAAE,iCAAiC,EAAE,MAAM,oCAAoC,CAAC;AACvF,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AACpG,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,0EAA0E;AAC1E,OAAO,EAAE,oCAAoC,EAAE,MAAM,uCAAuC,CAAC;AAC7F,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO;AACP,OAAO,EAAE,iCAAiC,EAAE,MAAM,oCAAoC,CAAC;AACvF,OAAO,EAAE,4BAA4B,EAAE,MAAM,4BAA4B,CAAC;AAC1E,OAAO,EAAE,oCAAoC,EAAE,MAAM,uCAAuC,CAAC;AAC7F,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,YAAY;AACZ,OAAO,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACnF,OAAO,EAAE,8CAA8C,EAAE,MAAM,wDAAwD,CAAC;AACxH,OAAO,EAAE,yCAAyC,EAAE,MAAM,mDAAmD,CAAC;AAC9G,OAAO;AACP,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACxF,OAAO;AACP,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAGxF,SAAS,aAAa,CAAC,SAAoB;IACzC,SAAS;IACT,kCAAkC,CAAC,SAAS,CAAC,CAAC;IAC9C,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACpC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACpC,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAClC,wCAAwC,CAAC,SAAS,CAAC,CAAC;IACpD,OAAO;IACP,iCAAiC,CAAC,SAAS,CAAC,CAAC;IAC7C,uCAAuC,CAAC,SAAS,CAAC,CAAC;IACnD,qCAAqC,CAAC,SAAS,CAAC,CAAC;IACjD,0BAA0B,CAAC,SAAS,CAAC,CAAC;IACtC,2CAA2C;IAC3C,oCAAoC,CAAC,SAAS,CAAC,CAAC;IAChD,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAClC,OAAO;IACP,iCAAiC,CAAC,SAAS,CAAC,CAAC;IAC7C,4BAA4B,CAAC,SAAS,CAAC,CAAC;IACxC,oCAAoC,CAAC,SAAS,CAAC,CAAC;IAChD,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAClC,YAAY;IACZ,4BAA4B,CAAC,SAAS,CAAC,CAAC;IACxC,8CAA8C,CAAC,SAAS,CAAC,CAAC;IAC1D,yCAAyC,CAAC,SAAS,CAAC,CAAC;IACrD,OAAO;IACP,qCAAqC,CAAC,SAAS,CAAC,CAAC;IACjD,iCAAiC,CAAC,SAAS,CAAC,CAAC;IAC7C,OAAO;IACP,iCAAiC,CAAC,SAAS,CAAC,CAAC;AAC/C,CAAC;AAED,OAAO,EACL,aAAa,GACd,CAAA"}

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

@@ -1,354 +0,0 @@
-## TUICallKit (including UI Interface)
-
-## TUICallKit APIs
-
-UICallKit API, you can quickly implement a WeChat-like audio and video call scenario through simple interfaces.
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >API</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[login](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Login.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[logout](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Logout.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[calls](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Initiate a one-to-one or multi-person call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[call](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >To make a one-on-one call, supports custom room ID, call timeout, offline push content, and more.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[groupCall](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >To make a group call, supports custom room ID, call timeout, offline push content, and more.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[joinInGroupCall](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Join a group call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setCallingBell](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Customize user's ringtone.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[enableMuteMode](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Enable/Disable Ringtone.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[enableVirtualBackground](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Enable/disable blurry background feature.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setScreenOrientation](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Set Screen Orientation.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[on](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Listen to TUICallKit events.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[off](https://write.woa.com/document/162412580951224320)</td>
-
-<td rowspan="1" colSpan="1" >Cancel listening to TUICallKit events.</td>
-</tr>
-</table>
-
-
-## TUICallEvent
-
-TUICallEvent is the callback event class corresponding to TUICallKit. Through this callback, you can listen to the callback events you are interested in.
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Event</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onError](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Error Callback during Call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onCallReceived](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Callback for a Call Request.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onCallCancelled](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Callback for Call Cancellation.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onCallBegin](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Callback for Call Connection.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onCallEnd](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Callback for Call Termination.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserReject](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >xxxx User declines the call Callback.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserNoResponse](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >xxxx User Non-response Callback.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserLineBusy](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >xxxx User Busy Line Callback.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserJoin](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >xxxx User Joins Call Callback.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserLeave](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >A user left the call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onCallMediaTypeChanged](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Callback for a change in the Call's Media Type.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onKickedOffline](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Current user kicked offline.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserSigExpired](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Ticket expired while online.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserVideoAvailable](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Whether a user has a video stream.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserAudioAvailable](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >Whether a user has an audio stream.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserVoiceVolumeChanged](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >The volume levels of all users.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[TUICallEvent.onUserNetworkQualityChanged](https://write.woa.com/document/162412628639113216)</td>
-
-<td rowspan="1" colSpan="1" >The network quality of all users.</td>
-</tr>
-</table>
-
-
-## TUICallEngine (No UI)
-
-`TUICallEngine` is an audio/video call component that **does not include UI elements**. If `TUICallKit` does not meet your requirements, you can use the APIs of `TUICallEngine` to customize your project.
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >API</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[createInstance](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Creates a `TUICallEngine` instance (singleton mode).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[destroyInstance](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Terminates a `TUICallEngine` instance (singleton mode).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[login](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Authenticates the basic audio/video call capabilities.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[on](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Registers an event listener.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[off](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Unregisters an event listener.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[call](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Makes a one-to-one call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[accept](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Accepts a call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[reject](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Rejects a call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[ignore](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Ignores a call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[hangup](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Ends a call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[switchCallMediaType](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Changes the call type, for example, from video call to audio call.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[startRemoteView](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Subscribes to the video stream of a remote user.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[stopRemoteView](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Unsubscribes from the video stream of a remote user.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[openCamera](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Turns the camera on.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[switchCamera](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Switches between the front and rear cameras.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[closeCamera](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Turns the camera off.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[openMicrophone](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Turns the mic on.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[closeMicrophone](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Turns the mic off.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[selectAudioPlaybackDevice](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Selects the audio playback device (receiver or speaker).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setVideoRenderParams](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Set the rendering mode of video image.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setVideoEncoderParams](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Set the encoding parameters of video encoder.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setBeautyLevel](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Set beauty level, support turning off default beauty.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setSelfInfo](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Sets the alias and profile photo.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[enableMultiDeviceAbility](https://write.woa.com/document/165654454250659840)</td>
-
-<td rowspan="1" colSpan="1" >Sets whether to enable multi-device login for `TUICallEngine` .</td>
-</tr>
-</table>