@tencent-rtc/mcp 1.3.8 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencent-rtc/mcp",
-  "version": "1.3.8",
+  "version": "1.4.0",
   "description": "Tencent Cloud MCP Server for SDK",
   "type": "module",
   "main": "index.js",
@@ -12,7 +12,7 @@
   "dependencies": {
     "@grpc/grpc-js": "^1.5.1",
     "@grpc/proto-loader": "^0.6.6",
-    "@modelcontextprotocol/sdk": "1.10.1",
+    "@modelcontextprotocol/sdk": "1.27.1",
     "@tencentcloud/sdk-mcp": "^1.0.3",
     "@types/express": "^5.0.1",
     "@types/hashring": "^3.2.1",

package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md}

@@ -24,9 +24,6 @@ Starting from TUICallKit version 3.1, in the TUIChat + TUICallKit integrated sce
 
 You need to call an advanced API once after successful log-in. Specific use on all platforms is as follows:
 
-
-
-
 【iOS(Swift)】
 ``` swift
 let jsonParams: [String: Any] = ["api": "forceUseV2API",
@@ -37,10 +34,9 @@ guard let paramsString = NSString(data: data, encoding: String.Encoding.utf8.raw
 TUICallKit.createInstance().callExperimentalAPI(jsonStr: paramsString)
 ```
 
-
 【iOS(Objective-C)】
 ``` cpp
-NSDictionary *jsonParams = @{@"api": @"forceUseV2API",    
+NSDictionary *jsonParams = @{@"api": @"forceUseV2API",
                              @"params": @{@"enable": @YES}};
 NSError *error = nil;
 NSData *data = [NSJSONSerialization dataWithJSONObject:jsonParams options:0 error:&error];
@@ -49,10 +45,8 @@ NSString *paramsString = [[NSString alloc] initWithData:data encoding:NSUTF8Stri
 if (!paramsString) { return;}
 [[TUICallKit createInstance] callExperimentalAPIWithJsonStr:paramsString];
 
-
 ```
 
-
 【Android(java)】
 ``` java
  try {
@@ -68,7 +62,6 @@ if (!paramsString) { return;}
 
 ```
 
-
 【Android(kotlin)】
 ``` java
 try {
@@ -85,21 +78,19 @@ try {
 
 ```
 
-
 【Flutter(Dart)】
 ``` java
-final jsonParams = {'api': 'forceUseV2API',    
-                 'params': {'enable': true} };  
-                 
-try {    
-    final jsonString = json.encode(jsonParams);    
-    TUICallKit.instance.callExperimentalAPI(jsonStr: jsonString);  
-} catch (e) {    
-    return;  
+final jsonParams = {'api': 'forceUseV2API',
+                 'params': {'enable': true} };
+
+try {
+    final jsonString = json.encode(jsonParams);
+    TUICallKit.instance.callExperimentalAPI(jsonStr: jsonString);
+} catch (e) {
+    return;
 }
 ```
 
-
 【Web & Mini Programs】
 ``` javascript
 const jsonObject = {
@@ -111,17 +102,14 @@ const jsonObject = {
 TUICallKitServer.getTUICallEngineInstance().callExperimentalAPI(JSON.stringfy(jsonObject));
 ```
 
-### 
+###
 
 ### 7.How to get the log files of each platform?
 
 The current log file paths of each platform are as follows:
 
-
 - iOS or Mac: In the sandbox Documents/log folder.
 
 - Android: In the /sdcard/Android/data/[your application package name]/files/log/liteav/ folder.
 
 - Windows: In the C:/Users/[system username]/AppData/Roaming/liteav/log, i.e. %APPDATA%/liteav/log folder.
-
-

package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md}

@@ -24,9 +24,6 @@ Starting from TUICallKit version 3.1, in the TUIChat + TUICallKit integrated sce
 
 You need to call an advanced API once after successful log-in. Specific use on all platforms is as follows:
 
-
-
-
 【iOS(Swift)】
 ``` swift
 let jsonParams: [String: Any] = ["api": "forceUseV2API",
@@ -37,10 +34,9 @@ guard let paramsString = NSString(data: data, encoding: String.Encoding.utf8.raw
 TUICallKit.createInstance().callExperimentalAPI(jsonStr: paramsString)
 ```
 
-
 【iOS(Objective-C)】
 ``` cpp
-NSDictionary *jsonParams = @{@"api": @"forceUseV2API",    
+NSDictionary *jsonParams = @{@"api": @"forceUseV2API",
                              @"params": @{@"enable": @YES}};
 NSError *error = nil;
 NSData *data = [NSJSONSerialization dataWithJSONObject:jsonParams options:0 error:&error];
@@ -49,10 +45,8 @@ NSString *paramsString = [[NSString alloc] initWithData:data encoding:NSUTF8Stri
 if (!paramsString) { return;}
 [[TUICallKit createInstance] callExperimentalAPIWithJsonStr:paramsString];
 
-
 ```
 
-
 【Android(java)】
 ``` java
  try {
@@ -68,7 +62,6 @@ if (!paramsString) { return;}
 
 ```
 
-
 【Android(kotlin)】
 ``` java
 try {
@@ -85,21 +78,19 @@ try {
 
 ```
 
-
 【Flutter(Dart)】
 ``` java
-final jsonParams = {'api': 'forceUseV2API',    
-                 'params': {'enable': true} };  
-                 
-try {    
-    final jsonString = json.encode(jsonParams);    
-    TUICallKit.instance.callExperimentalAPI(jsonStr: jsonString);  
-} catch (e) {    
-    return;  
+final jsonParams = {'api': 'forceUseV2API',
+                 'params': {'enable': true} };
+
+try {
+    final jsonString = json.encode(jsonParams);
+    TUICallKit.instance.callExperimentalAPI(jsonStr: jsonString);
+} catch (e) {
+    return;
 }
 ```
 
-
 【Web & Mini Programs】
 ``` javascript
 const jsonObject = {
@@ -111,17 +102,14 @@ const jsonObject = {
 TUICallKitServer.getTUICallEngineInstance().callExperimentalAPI(JSON.stringfy(jsonObject));
 ```
 
-### 
+###
 
 ### 7.How to get the log files of each platform?
 
 The current log file paths of each platform are as follows:
 
-
 - iOS or Mac: In the sandbox Documents/log folder.
 
 - Android: In the /sdcard/Android/data/[your application package name]/files/log/liteav/ folder.
 
 - Windows: In the C:/Users/[system username]/AppData/Roaming/liteav/log, i.e. %APPDATA%/liteav/log folder.
-
-

package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md}

@@ -24,9 +24,6 @@ Starting from TUICallKit version 3.1, in the TUIChat + TUICallKit integrated sce
 
 You need to call an advanced API once after successful log-in. Specific use on all platforms is as follows:
 
-
-
-
 【iOS(Swift)】
 ``` swift
 let jsonParams: [String: Any] = ["api": "forceUseV2API",
@@ -37,10 +34,9 @@ guard let paramsString = NSString(data: data, encoding: String.Encoding.utf8.raw
 TUICallKit.createInstance().callExperimentalAPI(jsonStr: paramsString)
 ```
 
-
 【iOS(Objective-C)】
 ``` cpp
-NSDictionary *jsonParams = @{@"api": @"forceUseV2API",    
+NSDictionary *jsonParams = @{@"api": @"forceUseV2API",
                              @"params": @{@"enable": @YES}};
 NSError *error = nil;
 NSData *data = [NSJSONSerialization dataWithJSONObject:jsonParams options:0 error:&error];
@@ -49,10 +45,8 @@ NSString *paramsString = [[NSString alloc] initWithData:data encoding:NSUTF8Stri
 if (!paramsString) { return;}
 [[TUICallKit createInstance] callExperimentalAPIWithJsonStr:paramsString];
 
-
 ```
 
-
 【Android(java)】
 ``` java
  try {
@@ -68,7 +62,6 @@ if (!paramsString) { return;}
 
 ```
 
-
 【Android(kotlin)】
 ``` java
 try {
@@ -85,21 +78,19 @@ try {
 
 ```
 
-
 【Flutter(Dart)】
 ``` java
-final jsonParams = {'api': 'forceUseV2API',    
-                 'params': {'enable': true} };  
-                 
-try {    
-    final jsonString = json.encode(jsonParams);    
-    TUICallKit.instance.callExperimentalAPI(jsonStr: jsonString);  
-} catch (e) {    
-    return;  
+final jsonParams = {'api': 'forceUseV2API',
+                 'params': {'enable': true} };
+
+try {
+    final jsonString = json.encode(jsonParams);
+    TUICallKit.instance.callExperimentalAPI(jsonStr: jsonString);
+} catch (e) {
+    return;
 }
 ```
 
-
 【Web & Mini Programs】
 ``` javascript
 const jsonObject = {
@@ -111,17 +102,14 @@ const jsonObject = {
 TUICallKitServer.getTUICallEngineInstance().callExperimentalAPI(JSON.stringfy(jsonObject));
 ```
 
-### 
+###
 
 ### 7.How to get the log files of each platform?
 
 The current log file paths of each platform are as follows:
 
-
 - iOS or Mac: In the sandbox Documents/log folder.
 
 - Android: In the /sdcard/Android/data/[your application package name]/files/log/liteav/ folder.
 
 - Windows: In the C:/Users/[system username]/AppData/Roaming/liteav/log, i.e. %APPDATA%/liteav/log folder.
-
-

package/resource/doc/callkit/preset/android/api.md

@@ -0,0 +1,296 @@
+## TUICallKit APIs
+
+`TUICallKit` is an audio/video call component that **includes UI elements**. You can use its APIs to quickly implement an audio/video call application similar to WeChat. For directions on integration, see [Integrating TUICallKit](https://www.tencentcloud.com/document/product/647/50991).
+
+## API Overview
+| API | Description |
+| --- | --- |
+| createInstance | Creates a `TUICallKit` instance (singleton mode). |
+| setSelfInfo | Sets the alias and profile photo. |
+| calls | Initiate a one-to-one or multi-person call. |
+| join | Proactively join a call. |
+| setCallingBell | Sets the ringtone. |
+| enableMuteMode | Sets whether to turn on the mute mode. |
+| enableFloatWindow | Sets whether to enable floating windows. |
+| enableIncomingBanner | Sets whether to display incoming banner. |
+
+## Details
+
+### createInstance
+
+This API is used to create a `TUICallKit` singleton.
+
+【Kotlin】
+``` java
+fun createInstance(context: Context): TUICallKit
+```
+
+【Java】
+``` java
+TUICallKit createInstance(Context context)
+```
+
+### setSelfInfo
+
+This API is used to set the alias and profile photo. The alias cannot exceed 500 bytes, and the profile photo is specified by a URL.
+
+【Kotlin】
+``` java
+fun setSelfInfo(nickname: String?, avatar: String?, callback: TUICommonDefine.Callback?)
+```
+
+【Java】
+``` java
+void setSelfInfo(String nickname, String avatar, TUICommonDefine.Callback callback)
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| userIdList | List<String> | The target user IDs. |
+| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
+| params | TUICallDefine.CallParams | An additional parameter. such as roomID, call timeout, offline push info,etc |
+
+### calls
+
+Initiate a one-to-one or multi-person call.
+
+【kotlin】
+``` java
+ fun calls(
+     userIdList: List<String?>?, mediaType: TUICallDefine.MediaType?,
+     params: TUICallDefine.CallParams?, callback: TUICommonDefine.Callback?
+)
+```
+
+【Java】
+``` java
+ void calls(List<String> userIdList, TUICallDefine.MediaType mediaType,
+            TUICallDefine.CallParams params, TUICommonDefine.Callback callback)
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| userIdList | List<String> | The target user IDs. |
+| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
+| params | TUICallDefine.CallParams | An additional parameter. such as roomID, call timeout, offline push info,etc |
+
+### join
+
+Proactively join a call.
+
+【Kotlin】
+``` java
+ fun join(callId: String?, callback: TUICommonDefine.Callback?)
+```
+
+【Java】
+``` java
+void join(String callId, TUICommonDefine.Callback callback)
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| callId | String | Unique ID for this call |
+
+### setCallingBell
+
+This API is used to set the ringtone. `filePath` must be an accessible local file URL.
+
+The ringtone set is associated with the device and does not change with user.
+
+To reset the ringtone, pass in an empty string for `filePath`.
+
+【Kotlin】
+``` java
+fun setCallingBell(filePath: String?)
+```
+
+【Java】
+``` java
+void setCallingBell(String filePath);
+```
+
+### enableMuteMode
+
+This API is used to set whether to play the music when user received a call.
+
+【Kotlin】
+``` java
+fun enableMuteMode(enable: Boolean)
+```
+
+【Java】
+``` java
+void enableMuteMode(boolean enable);
+```
+
+### enableFloatWindow
+
+This API is used to set whether to enable floating windows.
+
+The default value is `false`, and the floating window button in the top left corner of the call view is hidden. If it is set to `true`, the button will become visible.
+
+【Kotlin】
+``` java
+fun enableFloatWindow(enable: Boolean)
+```
+
+【Java】
+``` java
+void enableFloatWindow(boolean enable);
+```
+
+### enableIncomingBanner
+
+The API is used to set whether show incoming banner when user received a new call invitation.
+
+The default value is `false`, The callee will pop up a full-screen call view by default when receiving the invitation. If it is set to `true`, the callee will display a banner first.
+``` java
+fun enableIncomingBanner(enable: Boolean)
+```
+
+## Deprecated Interface
+
+### call
+
+This API is used to make a (one-to-one) call. **Note:  it is recommended to use the calls API.**
+
+【Kotlin】
+``` java
+fun call(userId: String, callMediaType: TUICallDefine.MediaType)
+```
+
+【Java】
+``` java
+ void call(String userId, TUICallDefine.MediaType callMediaType)
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| userId | String | The target user ID. |
+| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
+
+### call
+
+This API is used to make a (one-to-one) call, Support for custom room ID, call timeout, offline push content, etc. **Note:  it is recommended to use the calls API.**
+
+【Kotlin】
+``` java
+fun call(
+    userId: String, callMediaType: TUICallDefine.MediaType,
+    params: CallParams?, callback: TUICommonDefine.Callback?
+)
+```
+
+【Java】
+``` java
+ void call(String userId, TUICallDefine.MediaType callMediaType,
+           TUICallDefine.CallParams params, TUICommonDefine.Callback callback)
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| userId | String | The target user ID. |
+| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
+| params | TUICallDefine.CallParams | Call extension parameters, such as roomID, call timeout, offline push info,etc |
+
+### groupCall
+
+This API is used to make a group call. **Note:  it is recommended to use the calls API.**
+
+> **Note:**
+>
+
+> Before making a group call, you need to create an Chat group first.
+>
+
+> For details about how to create a group, see [Chat Group Management](https://www.tencentcloud.com/zh/document/product/1047/48466#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84), or you can use [Chat UIKit](https://www.tencentcloud.com/zh/document/product/1047/60520) to integrate chat, call and other scenarios.
+>
+
+【Kotlin】
+``` java
+fun groupCall(groupId: String, userIdList: List<String?>?, callMediaType: TUICallDefine.MediaType)
+```
+
+【Java】
+``` java
+void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType);
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| groupId | String | The group ID. |
+| userIdList | List | The target user IDs. |
+| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
+
+### groupCall
+
+This API is used to make a group call, Support for custom room ID, call timeout, offline push content, etc. **Note:  it is recommended to use the calls API.**
+
+> **Note:**
+>
+
+> Before making a group call, you need to create an Chat group first.
+>
+
+> For details about how to create a group, see [Chat Group Management](https://www.tencentcloud.com/zh/document/product/1047/48466#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84), or you can use [Chat UIKit](https://www.tencentcloud.com/zh/document/product/1047/60520) to integrate chat, call and other scenarios.
+>
+
+【Kotlin】
+``` java
+fun groupCall(
+    groupId: String, userIdList: List<String?>?,
+    callMediaType: TUICallDefine.MediaType, params: CallParams?,
+    callback: TUICommonDefine.Callback?
+)
+```
+
+【Java】
+``` java
+void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType,
+               TUICallDefine.CallParams params, TUICommonDefine.Callback callback);
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| groupId | String | The group ID. |
+| userIdList | List | The target user IDs. |
+| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |
+| params | TUICallDefine.CallParams | Call extension parameters, such as roomID, call timeout, offline push info,etc |
+
+### joinInGroupCall
+
+This API is used to join a group call. **Note:  it is recommended to use the join API.**
+
+> **Note:**
+>
+
+> Before joining a group call, you need to create or join an Chat group in advance, and there are already users in the group who are in the call.
+>
+
+> For details about how to create a group, see [Chat Group Management](https://www.tencentcloud.com/zh/document/product/1047/48466#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84), or you can use [Chat UIKit](https://www.tencentcloud.com/zh/document/product/1047/60520) to integrate chat, call and other scenarios.
+>
+
+【Kotlin】
+``` java
+fun joinInGroupCall(roomId: RoomId?, groupId: String?, callMediaType: TUICallDefine.MediaType?)
+```
+
+【Java】
+``` java
+void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefine.MediaType callMediaType);
+```
+
+The parameters are described below:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| roomId | TUICommonDefine.RoomId | The room ID. |
+| groupId | String | The group ID. |
+| callMediaType | TUICallDefine.MediaType | The call type, which can be video or audio. |