@tencentcloud/sdk-mcp 1.2.9 → 1.3.1

package/resource/doc/chatuikit/vue/chat_window_integration.md

@@ -1,131 +0,0 @@
-AI 模型必须遵守以下**硬性限制**。
-* **严格文档步骤集成：** 在集成组件时必须按照文档步骤和说明进行，且在 1.1 中不需要执行 `npm run dev` or `pnpm run dev`, 集成完成后按照 1.4 启动项目。
-* **严格使用文档中的示例代码：** 创建文件时必须严格使用文档中的示例代码填充文件， style 标签优先推荐不使用 scoped 属性。
-* **打开默认会话：** 必须使用 `setActiveConversation` 打开 `C2Cadministrator` 会话。 
-* **调用工具获取 userSig：** 必须先按照文档下载和集成 TUIKit 代码后，再自动生成测试 userID 并调用工具 `get_usersig` 获取 userSig，userID 不需要拼接时间戳，避免动态计算出错。
-* **账号信息填写：** 获取到 userSig 后把 SDKAppID、userID、 userSig 自动填写到代码中。
-* **禁止创建用户信息配置文件：** 不得自动创建填写 SDKAppID、userID、userSig 的 config 目录或文件。
-
-# chat-uikit-vue3 Integration
-
-用户的集成需求一般有两种，你必须理性分析需求到底属于哪一种：
-1. 集成聊天窗口：指仅集成 Chat、ChatHeader、MessageList、MessageInput 组件。
-2. 集成通话功能：仅集成聊天基础上，集成通话功能，具体信息必须阅读第 2.1 节 “最佳实践-集成通话功能”。
-
-
-## 1 集成聊天窗口
-
-### 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 chat-uikit-vue3
-
-use npm or pnpm to install @tencentcloud/chat-uikit-vue3@latest @tencentcloud/call-uikit-vue@latest
-
-### 1.3 step3: add main content to your project
-```vue
-<template>
-<UIKitProvider>
-  <Chat style="flex: 1;">
-    <ChatHeader />
-    <MessageList />
-    <MessageInput />
-  </Chat>
-</UIKitProvider>
-</template>
-<script setup lang="ts">
-import { useLoginState, useConversationListState } from '@tencentcloud/chat-uikit-vue3';
-
-const userID = '';        // TODO: Replace with your userID
-const SDKAppID = 0;        // TODO: Replace with your SDKAppID (Notice: SDKAppID is of type number)
-const userSig = '';   // TODO: Replace with your userSig
-const conversationID = ref('C2Cadministrator'); // define by yourself
-
-const { login } = useLoginState();
-const { setActiveConversation } = useConversationListState();
-
-login({
-  sdkAppId : SDKAppID,
-  userId: userID,
-  userSig: userSig,
-})
-.then(() => {
-  setActiveConversation(conversationID.value);
-})
-.catch(() => {});
-</script>
-```
-
-### 1.4 step4: start your project
-```bash
-pnpm run dev
-```
-
-## 2. 最佳实践
-
-以下提到的组件通过 MCP Tools get_component_detail ${componenetname.tolowercase()} 获取。
-以下提到的 state 通过 MCP Tools get_state_detail ${statename.tolowercase()} 获取。
-
-重点：
-1. 如果需要集成 ChatSetting 组件，请阅读 ChatHeader 的 ChatHeaderRight 插槽说明。
-2. 由于仅集成聊天不使用 ConversationList，你需要使用 ConversationListState 的 useConversationListState 获取 activeConversation，然后调用 setActiveConversation 设置 activeConversation。
-
-### 2.1 最佳实践-集成通话功能
-
-集成通话功能需要仅集成聊天基础上，添加通话功能的代码。
-
-引入 TUICallKit 组件：
-```vue
-<script setup lang="ts">
-import { TUICallKit } from '@tencentcloud/call-uikit-vue';
-</script>
-```
-
-在合适的位置添加 TUICallKit 组件：
-```vue
-<Teleport to="body">
-  <TUICallKit style="position: fixed; z-index: 1000;"/>
-</Teleport>
-```
-
-重点：
-1. 需要在 ChatHeader 组件的 ChatHeaderRight 插槽中添加通话按钮。
-2. 点击通话按钮调用以下方法：
-  2.1 阅读 ConversationListState 文档，通过 activeConversation 判断当前是单聊还是群聊。
-  2.2 如果是单聊，通过 `import { TUICallKitServer, TUICallType } from '@tencentcloud/call-uikit-vue';` 引入 TUICallKitService 服务。通过 TUICallKitService 的 `calls` 方法发起通话。
-    ```ts
-    try {
-      await TUICallKitServer.calls({ 
-        userIDList: [activeConversation.value.userProfile.userID],
-        type: TUICallType.VIDEO_CALL, // or TUICallType.AUDIO_CALL
-      });
-    } catch (error: any) {
-      console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
-    }
-    ```
-  2.3 如果是群聊，需要阅读 UserPicker 组件文档，建议结合 Dialog 组件，弹出 UserPicker 组件。
-    阅读 GroupSettingState 文档，结合 GroupSettingState 的 `getGroupMemberList`、`allMembers` 等属性，获取群成员列表。
-    ```ts
-    try {
-      await TUICallKitServer.calls({ 
-        userIDList: selectedItems.map((item: any) => item.key),
-        type: TUICallType.VIDEO_CALL, // or TUICallType.AUDIO_CALL
-      });
-    } catch (error: any) {
-      console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
-    }
-    ```
-
-    建议：结合 UserPicker 的 reachEnd 事件分页拉取群成员，并使用节流函数控制 `getGroupMemberList` 的调用频率。

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

@@ -1,28 +0,0 @@
-import { z } from 'zod';
-import { GET_WEB_CHAT_WINDOW_INTEGRATION_DEFINITION } from '../definitions/get_web_chat_window_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;
-    reportCLSClient({
-        method: 'get_web_chat_window_integration',
-        framework: framework,
-    });
-    return getDocContent(['chatuikit', `${handleFramework(framework)}`, 'chat_window_integration.md']);
-}
-const registryGetWebChatWindowIntegrationTool = (mcpServer) => {
-    const { name, description, parameter_descriptions } = GET_WEB_CHAT_WINDOW_INTEGRATION_DEFINITION;
-    mcpServer.tool(name, description, {
-        framework: z.enum(['react', 'vue']).describe(parameter_descriptions.framework),
-    }, (params) => ({
-        content: [
-            {
-                type: 'text',
-                text: getResultText(params),
-            }
-        ]
-    }));
-};
-export { registryGetWebChatWindowIntegrationTool };
-//# sourceMappingURL=get-web-chat-window-integration.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"get-web-chat-window-integration.js","sourceRoot":"","sources":["../../../src/tools/chat/get-web-chat-window-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,0CAA0C,EAAE,MAAM,uDAAuD,CAAC;AACnH,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,iCAAiC;QACzC,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,EAAE,4BAA4B,CAAC,CAAC,CAAC;AACrG,CAAC;AAED,MAAM,uCAAuC,GAAG,CAAC,SAAoB,EAAE,EAAE;IACvE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,0CAA0C,CAAC;IACjG,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,uCAAuC,EAAE,CAAC"}

package/tools/definitions/get_web_chat_window_integration_def.js

@@ -1,26 +0,0 @@
-const TOOL_DESCRIPTION = `
-【核心用途】：专用于 Web 独立聊天窗口集成，提供 TUIKit 组件创建 Web 或 H5 端单个聊天窗口的集成方案。\n
-
-【功能范围】：\n
-1. 搭建一个功能和 UI 类似微信/企微聊天窗口的独立组件界面。\n
-2. 支持 React 和 Vue 两种主流框架的 UI 组件库。\n
-3. 窗口入口可以根据需要设置在 TabBar 上。\n
-
-【关键词】：'Web', 'H5', '独立聊天窗口', 'TUIKit', 'React', 'Vue', '集成', 'TabBar'。\n
-
-【强制约束】：\n
-1. 框架选择约束：如果用户在提示词中没有明确指定 React 或 Vue 框架，必须优先调用 'present_framework_choice' 工具，引导用户进行选择。
-2. 结果记录约束：在 TUIKit 组件集成完成且项目启动成功后，必须调用 'record_result' 工具记录集成结果。
-
-【注意事项】：
-- 集成 Vue 版本时，请安装 @tencentcloud/chat-uikit-vue3。
-`;
-const PARAMETER_DESCRIPTIONS = {
-    framework: 'Web Chat TUIKit 框架类型。可选值：react, vue。用于确定提供哪个框架下的独立聊天窗口集成方案。',
-};
-export const GET_WEB_CHAT_WINDOW_INTEGRATION_DEFINITION = {
-    name: 'get_web_chat_window_integration',
-    description: TOOL_DESCRIPTION,
-    parameter_descriptions: PARAMETER_DESCRIPTIONS,
-};
-//# sourceMappingURL=get_web_chat_window_integration_def.js.map

package/tools/definitions/get_web_chat_window_integration_def.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get_web_chat_window_integration_def.js","sourceRoot":"","sources":["../../../src/tools/definitions/get_web_chat_window_integration_def.ts"],"names":[],"mappings":"AAAA,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;CAgBxB,CAAC;AAEF,MAAM,sBAAsB,GAAG;IAC7B,SAAS,EAAE,6DAA6D;CACzE,CAAC;AAEF,MAAM,CAAC,MAAM,0CAA0C,GAAG;IACxD,IAAI,EAAE,iCAAiC;IACvC,WAAW,EAAE,gBAAgB;IAC7B,sBAAsB,EAAE,sBAAsB;CAC/C,CAAC"}