@tencent-rtc/mcp 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -35
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,61 +1,63 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
This repository provides a CLI-based Model Context Protocol (MCP) server that exposes Tencent SDK documentation and Tencent API resources to LLM-powered tools.
|
|
4
|
-
This improves the LLM AI Agent's ability to understand and interact with Tencent's SDKs and APIs.
|
|
1
|
+
# Tencent RTC MCP Server User Guide
|
|
5
2
|
|
|
3
|
+
This repository provides a Model Context Protocol (MCP) server based on the Command Line Interface (CLI). It delivers Tencent Cloud SDK documentation and API resources to Large Language Model (LLM) based tools. This enhances the ability of LLM AI agents to understand and interact with Tencent Cloud SDKs and APIs, facilitating seamless integration of Tencent Cloud services into applications.
|
|
6
4
|
|
|
7
5
|
## Features
|
|
8
6
|
|
|
9
|
-
- MCP
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
- TUICallKit SDK languages: JavaScript, Kotlin, Swift.
|
|
16
|
-
- TUICallKit SDK topics: configuration, calls function.
|
|
17
|
-
- Converts remote HTML articles to Markdown using `jsdom` and `turndown` for consistent documentation formatting.
|
|
18
|
-
- Input validation via Zod schemas for all tool parameters, ensuring robust error handling.
|
|
19
|
-
- Extensible tool definitions leveraging the Model Context Protocol SDK (`@modelcontextprotocol/sdk`) with `McpServer` and `StdioServerTransport`.
|
|
7
|
+
- **MCP Server**: Provides tools for interacting with Tencent Cloud via the JSON-RPC protocol over STDIN/STDOUT.
|
|
8
|
+
- **Languages**: JavaScript, Java, Swift, Objective-C, Kotlin.
|
|
9
|
+
- **API Reference Section**: Configuration, function invocation. Access code examples, usage patterns, and detailed explanations of Tencent Cloud SDK features.
|
|
10
|
+
- **Tencent Cloud TUICallKit SDK Documentation Retrieval**: Retrieve official Tencent Cloud TUICallKit SDK documentation (converted from HTML to Markdown format), covering the following:
|
|
11
|
+
|
|
12
|
+
## Example Prompts
|
|
20
13
|
|
|
14
|
+
- "Develop an Android application that supports audio and video calls using TUICallKit."
|
|
15
|
+
- "Implement audio and video call functionality in our project by integrating TUICallKit."
|
|
16
|
+
- "Retrieve the API usage documentation for React TUICallKit."
|
|
21
17
|
|
|
22
18
|
## Prerequisites
|
|
23
|
-
- Node.js (>= 18) and npm
|
|
24
|
-
- Cursor IDE with MCP support
|
|
25
19
|
|
|
20
|
+
- Node.js (version >= 18) and npm (https://nodejs.org/)
|
|
21
|
+
- Cursor IDE with MCP support
|
|
26
22
|
|
|
27
|
-
##
|
|
28
|
-
To set up the @tencentcloud/sdk-mcp MCP Server, follow these steps:
|
|
23
|
+
## Installation
|
|
29
24
|
|
|
30
|
-
|
|
25
|
+
To run the Tencent Cloud MCP server locally or add it to Cursor IDE via npx:
|
|
31
26
|
|
|
32
27
|
```
|
|
33
|
-
npx -y @
|
|
28
|
+
npx -y @tencent-rtc/mcp
|
|
34
29
|
```
|
|
35
30
|
|
|
31
|
+
## Cursor Configuration
|
|
32
|
+
|
|
33
|
+
To use the MCP server, Cursor must be in AGENT MODE. The Cursor IDE discovers MCP servers through a JSON configuration file. You can configure the Tencent Cloud MCP server globally or per project.
|
|
36
34
|
|
|
37
|
-
|
|
35
|
+
### Global Configuration
|
|
38
36
|
|
|
39
|
-
|
|
37
|
+
Edit or create the file ~/.cursor/mcp.json:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
40
|
{
|
|
41
41
|
"mcpServers": {
|
|
42
|
-
"
|
|
42
|
+
"tencent-rtc": {
|
|
43
43
|
"command": "npx",
|
|
44
|
-
"args": ["-y", "@
|
|
44
|
+
"args": ["-y", "@tencent-rtc/mcp"],
|
|
45
45
|
}
|
|
46
46
|
}
|
|
47
47
|
}
|
|
48
48
|
```
|
|
49
|
-
When you save the file, a notification is displayed. In the prompt, click **Enable**.
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
- Step3: Navigate to **Cursor Settings** (the gear icon in top right corner) -> **MCP**, and check if tencentcloud-sdk-mcp server is enabled.
|
|
54
49
|
|
|
55
|
-
|
|
50
|
+
### Project Configuration
|
|
56
51
|
|
|
52
|
+
In the project directory, create .cursor/mcp.json:
|
|
57
53
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
54
|
+
```
|
|
55
|
+
{
|
|
56
|
+
"mcpServers": {
|
|
57
|
+
"tencent-rtc": {
|
|
58
|
+
"command": "npx",
|
|
59
|
+
"args": ["-y", "@tencent-rtc/mcp"],
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|