Skip to content

Commit d73d63d

Browse files
uyarnRylanBot
andauthored
chore: add mcp usage docs (#2454)
* chore: add mcp usage docs * chore: add mcp usage docs * chore: update docs * chore: update docs * chore: remove extra space * chore: update link --------- Co-authored-by: Rylan <rylanbot@qq.com>
1 parent 34f344a commit d73d63d

File tree

2 files changed

+115
-0
lines changed

2 files changed

+115
-0
lines changed

docs/mcp.en-US.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: TDesign MCP
3+
description: A long-term maintained MCP tool provided by TDesign for more efficient and accurate use of TDesign development resources in AI-assisted programming scenarios.
4+
spline: ai
5+
---
6+
7+
TDesign provides a long-term maintained [MCP](https://cnb.cool/tencent/tdesign/tdesign-mcp-server) tool that can be activated with simple configuration, enabling more efficient and accurate use of TDesign development resources in AI-assisted programming scenarios.
8+
9+
## How to Install TDesign MCP
10+
11+
In any AI IDE that supports the MCP protocol, add the following configuration to your MCP settings:
12+
13+
```javascript
14+
{
15+
"mcpServers": {
16+
// or "servers" (depending on your MCP client)
17+
"tdesign-mcp-server": {
18+
"command": "npx",
19+
"args": ["-y", "tdesign-mcp-server@latest"]
20+
}
21+
}
22+
}
23+
```
24+
25+
## How to Use TDesign MCP
26+
27+
TDesign MCP currently includes four built-in tools: `get-component-docs`, `get-component-list`, `get-component-changelog`, and `get-component-dom`. These tools help address various practical needs when using TDesign, including but not limited to assisted code generation, resolving API usage issues, upgrading component library versions, and assisting with code migration.
28+
29+
### Assisted Code Generation
30+
31+
With natural language descriptions, you can quickly write code with the help of TDesign MCP.
32+
33+
<video controls width="100%">
34+
<source src="https://tdesign.gtimg.com/site/mcp/mcp-vibecoding.mp4" type="video/mp4" />
35+
</video>
36+
37+
### Resolving API Usage Issues
38+
39+
By providing more accurate context through TDesign MCP, models can quickly identify issues when using TDesign.
40+
41+
<video controls width="100%">
42+
<source src="https://tdesign.gtimg.com/site/mcp/mcp-fix.mp4" type="video/mp4" />
43+
</video>
44+
45+
### Upgrading Component Library Versions
46+
47+
By using TDesign MCP to retrieve the changelog of your current TDesign tech stack, you can streamline the TDesign upgrade process and quickly perform targeted regression testing for specific feature updates.
48+
49+
<video controls width="100%">
50+
<source src="https://tdesign.gtimg.com/site/mcp/mcp-changelog.mp4" type="video/mp4" />
51+
</video>

docs/mcp.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: TDesign MCP
3+
description: TDesign 提供的长期维护的 MCP 工具, 用于在 AI 辅助编程的场景中更高效、更准确地使用 TDesign 的各种开发资源。
4+
spline: ai
5+
---
6+
7+
TDesign 提供长期维护的 [MCP](https://cnb.cool/tencent/tdesign/tdesign-mcp-server) 工具,通过简单的配置即可生效,用于在 AI 辅助编程的场景中更高效、更准确地使用 TDesign 的各种开发资源。
8+
9+
## 如何安装 TDesign MCP
10+
11+
在任何支持 MCP 协议的 AI IDE 中,将以下配置添加到 MCP 配置中
12+
13+
```javascript
14+
{
15+
"mcpServers": {
16+
// 或 servers(根据不同的 MCP 客户端决定)
17+
"tdesign-mcp-server": {
18+
"command": "npx",
19+
"args": ["-y", "tdesign-mcp-server@latest"]
20+
}
21+
}
22+
}
23+
```
24+
25+
如果您在腾讯内网,也可以通过 http 方式使用 TDesign MCP
26+
27+
```javascript
28+
{
29+
"mcpServers": {
30+
// 或 servers(根据不同的 MCP 客户端决定)
31+
"tdesign-mcp-server-http": {
32+
"url": "http://mcp.tdesign.woa.com/mcp"
33+
}
34+
}
35+
}
36+
```
37+
38+
## 如何使用 TDesign MCP
39+
40+
TDesign MCP 目前内置了四个 tools,分别是 `get-component-docs``get-component-list``get-component-changelog``get-component-dom`,用于辅助解决使用 TDesign 过程中的各种实际需求,包括但不限于辅助代码生成、解决 API 使用问题、升级组件库版本和辅助代码迁移等场景。
41+
42+
### 辅助代码生成
43+
44+
通过自然语言描述,可以配合 TDesign MCP 快速进行代码编写。
45+
46+
<video controls width="100%">
47+
<source src="https://tdesign.gtimg.com/site/mcp/mcp-vibecoding.mp4" type="video/mp4" />
48+
</video>
49+
50+
### 解决 API 使用问题
51+
52+
通过 TDesign MCP 提供更准确的上下文,可以辅助模型更快定位到使用 TDesign 的问题。
53+
54+
<video controls width="100%">
55+
<source src="https://tdesign.gtimg.com/site/mcp/mcp-fix.mp4" type="video/mp4" />
56+
</video>
57+
58+
### 升级组件库的版本
59+
60+
通过 TDesign MCP 获取当前使用的 TDesign 技术栈的更新日志,可以辅助解决升级 TDesign 的过程,快速对一些功能升级进行针对性回归。
61+
62+
<video controls width="100%">
63+
<source src="https://tdesign.gtimg.com/site/mcp/mcp-changelog.mp4" type="video/mp4" />
64+
</video>

0 commit comments

Comments
 (0)