@tencent-rtc/mcp 1.3.0 → 1.3.1

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

@@ -1,94 +0,0 @@
-The AI model must comply with the following **hard restrictions**:
-* **React Version Restriction:** When creating the project, both React and react-dom versions must be `18.2.0`. React 19 is prohibited.
-* **React UIKit Version Restriction:** The latest version of `@tencentcloud/chat-uikit-react` 3.0.0 or higher must be used.
-* **Strictly Follow the Documentation Steps and Instructions for Integration:** When integrating components, the steps and instructions in the documentation must be followed precisely.
-* **Strictly Use the Sample Code in the Documentation:** When creating files, the sample code in the documentation must be used to populate the files. The PlaceholderEmpty property of the Chat component does not need to be filled in.
-* **Open Default Conversation:** The `C2Cadministrator` conversation must be opened using `setActiveConversation`.
-* **Retrieve userSig using a tool:** The TUIKit code must be downloaded and integrated according to the documentation before automatically generating a test userID and calling the `get_usersig` tool to retrieve the userSig. The userID does not need to be appended with a timestamp to avoid errors in dynamic calculation.
-* **Account Information Filling:** After obtaining the userSig, the SDKAppID, userID, and userSig will be automatically filled into the code.
-* **Prohibit Creating User Information Configuration Files:** The `config` directory or file for filling in SDKAppID, userID, and userSig must not be automatically created.
-
-# chat-uikit-react Integration
-
-
-## step1:create react project
-
-
-requirement: react: 18.2.0, react-dom: 18.2.0.
-
-
-you can use vite or rsbuild to create a react project.
-
-
-## step2: install chat-uikit-react
-
-
-use npm or pnpm to install @tencentcloud/chat-uikit-react
-
-
-## step3: add chat-uikit-react to your project
-
-
-example code
-
-
-```tsx
-import {
-  UIKitProvider,
-  useLoginState,
-  LoginStatus,
-  Chat,
-  ChatHeader,
-  MessageList,
-  MessageInput,
-  useConversationListState,
-} from "@tencentcloud/chat-uikit-react";
-
-function ChatApp() {
-  const { setActiveConversation } = useConversationListState();
-
-  useEffect(() => {
-    // open default conversation
-    setActiveConversation('C2Cadministrator');
-  }, [setActiveConversation]);
-
-  return (
-    <div style={{ height: '100vh', width: '100vw', display: 'flex', flexDirection: 'row' }}>
-      <Chat PlaceholderEmpty=''>
-        <ChatHeader />
-        <MessageList />
-        <MessageInput />
-      </Chat>
-    </div>
-  );
-}
-
-
-function App() {
-  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 { status } = useLoginState({
-    SDKAppID,
-    userID,
-    userSig,
-  })
-
-
-  if (status !== LoginStatus.SUCCESS) {
-    return <div>Loading...</div>
-  }
-  
-  // Language support zh-CN(default) / en-US / ja-JP / ko-KR / zh-TW
-  // Theme support light(default) / dark
-  return (
-    <UIKitProvider language='zh-CN' theme='light'>
-      <ChatApp />
-    </UIKitProvider>
-  );
-}
-
-
-export default App;
-```

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

@@ -1,156 +0,0 @@
-The AI model must comply with the following **hard restrictions**:
-* **Strictly required document procedure integration:** You must perform the integration according to the document procedure and description. In step 1.1, `npm run dev` or `pnpm run dev` is not required. Upon completion, start the project as per step 1.4.
-* **Strictly use the example code in the documentation:** You must strictly use the example code in the document to fill the file when creating a file. For the style tag, non-use of the scoped property is recommended.
-* **Open Default Conversation:** The `C2Cadministrator` conversation must be opened using `setActiveConversation`.
-* **Retrieve userSig using a tool:** The TUIKit code must be downloaded and integrated according to the documentation before automatically generating a test userID and calling the `get_usersig` tool to retrieve the userSig. The userID does not need to be appended with a timestamp to avoid errors in dynamic calculation.
-* **Account Information Filling:** After obtaining the userSig, the SDKAppID, userID, and userSig will be automatically filled into the code.
-* **Prohibit Creating User Information Configuration Files:** The `config` directory or file for filling in SDKAppID, userID, and userSig must not be automatically created.
-
-
-# chat-uikit-vue3 Integration
-
-
-User's integration needs have two types. You must rationally analyze which type the need belongs to.
-1. Integrate chat window: Refers to integrating only Chat, ChatHeader, MessageList, and MessageInput components.
-2. Integrate call feature: On the basis of integrated chat only, integrate call feature. You must read section 2.1 "Best Practice - Integrate Call Feature" for details.
-
-
-
-
-1. Seamless integration of chat window
-
-
-### 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
-```
-
-
-Best Practices
-
-
-The following components can be retrieved via MCP Tools get_component_detail ${componenetname.tolowercase()}.
-The following states can be retrieved via MCP Tools get_state_detail ${statename.tolowercase()}.
-
-
-Focus
-1. If necessary, integrate the ChatSetting component, please read the ChatHeaderRight slot description in ChatHeader.
-2. Since integrated chat only does not use ConversationList, you need to obtain activeConversation via useConversationListState of ConversationListState, then call setActiveConversation to set activeConversation.
-
-
-### 2.1 Best Practice - Seamless Integration of Call Feature
-
-
-Integrate call feature: On the basis of integrated chat only, add code for call feature.
-
-
-Introduce TUICallKit.
-```vue
-<script setup lang="ts">
-import { TUICallKit } from '@tencentcloud/call-uikit-vue';
-</script>
-```
-
-
-Add TUICallKit at the appropriate position:
-```vue
-<Teleport to="body">
-  <TUICallKit style="position: fixed; z-index: 1000;"/>
-</Teleport>
-```
-
-
-Focus
-1. Add a call button to the ChatHeaderRight slot in the ChatHeader Component.
-2. Click the call button to call the following method:
-  2.1 Read the ConversationListState document and use activeConversation to judge whether it is a single chat or group chat.
-  2.2 If it is a one-to-one chat, use `import { TUICallKitServer, TUICallType } from '@tencentcloud/call-uikit-vue';` to introduce the TUICallKitService service. Initiate call via the `calls` method of TUICallKitService.
-    ```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 If it is a group chat, read the UserPicker component document. It is advisable to combine with the Dialog component and pop up the UserPicker component.
-    Read the GroupSettingState document, combine GroupSettingState's `getGroupMemberList` and `allMembers` to get the group member list.
-    ```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}`);
-    }
-    ```
-
-
-    Recommendation: Combine the `reachEnd` event of UserPicker with paged pull to get group members, and use traffic throttling to control the call frequency of `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 = `
-[CORE FUNCTION]: Specialized for Web Standalone Chat Window Integration, providing the solution for creating a single chat window component using TUIKit on Web or H5 platforms.\n
-
-[SCOPE]:\n
-1. Builds a standalone component interface with functionality and UI similar to a WeChat or WeChat Work chat window.\n
-2. Supports UI component libraries for both React and Vue mainstream frameworks.\n
-3. The window entry can be set on a TabBar as needed.\n
-
-[KEYWORDS]: 'Web', 'H5', 'Standalone Chat Window', 'TUIKit', 'React', 'Vue', 'Integration', 'TabBar'.\n
-
-[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
-
-[NOTES]:\n
-- When integrating the Vue version, please install @tencentcloud/chat-uikit-vue3.
-`;
-const PARAMETER_DESCRIPTIONS = {
-    framework: 'The Web Chat TUIKit framework type. Options: react, vue. Used to determine which framework\'s standalone chat window integration solution to provide.',
-};
-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,uJAAuJ;CACnK,CAAC;AAEF,MAAM,CAAC,MAAM,0CAA0C,GAAG;IACxD,IAAI,EAAE,iCAAiC;IACvC,WAAW,EAAE,gBAAgB;IAC7B,sBAAsB,EAAE,sBAAsB;CAC/C,CAAC"}