Skip to content

Commit 28c452b

Browse files
committed
docs: add ai assistant docs
1 parent 85741ff commit 28c452b

11 files changed

Lines changed: 226 additions & 0 deletions
63.8 KB
Loading
40.5 KB
Loading
34.5 KB
Loading
20.3 KB
Loading
1.62 KB
Loading
19.7 KB
Loading
8.4 KB
Loading
24 KB
Loading
33 KB
Loading
Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
# 新版AI插件使用指南
2+
3+
随着TinyEngine低代码平台的不断升级,AI插件也迎来了重大更新。新版AI插件(v2.8以上版本)采用了全新的TinyRobot组件库界面,同时通过使用OpenTiny Next SDK 集成了MCP(Model Context Protocol)工具使用能力,使AI能够调用平台各插件提供的工具能力,实现更强大的自动化操作功能。
4+
5+
## 一、功能概览
6+
7+
新版AI插件具备以下核心功能:
8+
9+
1. **全新UI界面**:采用TinyRobot组件库,提供更现代化的聊天体验,支持Markdown语法、支持全屏模式等
10+
2. **智能对话**:支持与AI进行自然语言交互,完成复杂任务
11+
3. **Next SDK 与 MCP工具集成**:可以调用平台插件提供的各种工具,如修改属性、修改样式、创建页面等
12+
13+
## 二、界面介绍
14+
15+
### 2.1 主界面
16+
17+
在编辑器界面左下角插件栏,您可以看到 AI 助手的图标。点击图标即可打开主界面对话窗口。
18+
19+
![打开AI助手](./imgs/ai-assistant-open.png)
20+
21+
主界面包含以下元素:
22+
- **欢迎区域**:显示AI助手的欢迎信息
23+
- **提示项**:快速开始的常用问题示例
24+
- **对话区域**:显示用户与AI的对话历史
25+
- **输入区域**:用户输入问题的地方
26+
- **MC工具按钮**:管理和配置MCP工具的入口
27+
28+
![AI插件主界面](./imgs/ai-assistant-interface.png)
29+
30+
### 2.2 设置
31+
32+
点击顶部的设置图标,可以进行以下配置:
33+
- 选择 AI 模型:支持多种大型语言模型
34+
- 设置 API Token:配置访问 AI 服务所需的认证信息
35+
36+
![AI设置面板](./imgs/ai-assistant-settings.png)
37+
38+
注意:切换 AI 模型会开启新的会话。
39+
40+
41+
### 2.3 MCP工具管理
42+
43+
![MCP工具管理](./imgs/ai-assistant-mcp-tools-management.png)
44+
45+
MCP工具管理面板允许用户:
46+
- 查看启用的MCP服务器
47+
- 启用/禁用特定的MCP工具
48+
- 添加新的MCP服务器(即将开放)
49+
50+
## 三、基础使用流程
51+
52+
53+
### 3.1 设置模型接口
54+
55+
1. [可选] 配置自定义的OpenAI兼容格式的大模型接口
56+
57+
通过AI插件的`customCompatibleAIModels`选项,支持自定义添加OpenAI兼容格式大模型
58+
59+
```javascript
60+
// registry.js
61+
[META_APP.Robot]: {
62+
options: {
63+
customCompatibleAIModels: [
64+
{ label: 'SiliconFlow:DeepSeek-V3', value: 'deepseek-ai/DeepSeek-V3', manufacturer: 'siliconflow' },
65+
{ label: 'Qwen:qwen-max', value: 'qwen-max', manufacturer: 'qwen' },
66+
]
67+
}
68+
},
69+
```
70+
71+
2. 配置本地的MCP工具调用使用的AI模型接口Proxy, 方便本地调试,以百炼为例:
72+
```javascript
73+
// vite.config.js
74+
const originProxyConfig = baseConfig.server.proxy
75+
baseConfig.server.proxy = {
76+
'/app-center/api/chat/completions': {
77+
target: 'https://dashscope.aliyuncs.com',
78+
changeOrigin: true,
79+
rewrite: path => path.replace('/app-center/api/', '/compatible-mode/v1/'),
80+
},
81+
...originProxyConfig,
82+
}
83+
```
84+
85+
### 3.2 打开AI插件
86+
87+
点击设计器左下角的AI图标即可打开AI插件对话框
88+
89+
### 3.2 配置AI模型
90+
91+
首次使用或切换AI模型时,需要进行配置:
92+
93+
1. 点击右上角设置按钮
94+
2. 选择合适的AI模型
95+
3. 输入对应的API Token
96+
97+
### 3.3 开始对话
98+
99+
在输入框中输入问题,按回车或点击发送按钮即可开始对话
100+
101+
## 四、MCP工具使用
102+
103+
### 4.1 MCP工具概览
104+
105+
MCP(Model Connector Protocol)是新版AI插件的核心功能之一。通过MCP,AI可以调用平台中各个插件提供的工具能力,例如:
106+
- 创建新页面
107+
- 修改组件属性
108+
- 修改样式设置
109+
- 查询页面列表
110+
- 添加国际化内容
111+
112+
### 4.2 启用MCP工具
113+
114+
1. 点击输入框左侧的"MCP"按钮打开工具管理面板
115+
2. 查看可用的MCP服务器和工具
116+
3. 启用需要的工具
117+
118+
![启用MCP工具](./imgs/ai-assistant-enable-mcp-tools.png)
119+
120+
### 4.3 使用MCP工具
121+
122+
当启用MCP工具后,AI在对话过程中会自动判断是否需要调用相关工具。例如:
123+
124+
1. 用户询问:"帮我创建一个用户列表页面"
125+
2. AI识别需要调用"创建页面"工具
126+
3. 自动执行创建页面操作
127+
4. 返回操作结果给用户
128+
129+
工具调用中(以查询天气Mock工具为例):
130+
![MCP工具调用示例中](./imgs/ai-assistant-tool-execution1.png)
131+
工具调用完成后会返回最终结果,也可以点击展开工具调用参数与结果:
132+
![MCP工具调用示例结果示例](./imgs/ai-assistant-tool-execution2.png)
133+
134+
## 五、典型使用场景
135+
136+
### 5.1 页面搭建场景 (即将开放)
137+
138+
用户可以通过自然语言描述来生成页面:
139+
140+
```
141+
用户:帮我创建一个包含用户信息表单的页面,需要有姓名、邮箱、手机号字段
142+
AI:好的,我将为您创建一个包含用户信息表单的页面...
143+
[执行创建页面操作]
144+
AI:已完成页面创建,您可以在页面列表中查看新创建的表单页面
145+
```
146+
147+
### 5.2 组件属性修改场景
148+
149+
用户可以通过对话修改画布中组件的属性:
150+
151+
```
152+
用户:将当前选中按钮的文字改为"提交",颜色改为蓝色
153+
AI:好的,我将为您修改按钮属性...
154+
[执行修改属性操作]
155+
AI:已完成按钮属性修改
156+
```
157+
158+
### 5.3 样式调整场景
159+
160+
用户可以通过自然语言调整组件样式:
161+
162+
```
163+
用户:把页面标题的文字大小调整为24px,居中显示
164+
AI:好的,我将为您调整标题样式...
165+
[执行修改样式操作]
166+
AI:已完成标题样式调整
167+
```
168+
169+
## 六、其他功能
170+
171+
### 6.1 会话管理
172+
173+
- **新建会话**:点击右上角的"新建会话"按钮可以开始新的对话
174+
175+
### 6.2 提示项快速开始
176+
177+
界面提供了几个提示项帮助用户快速开始:
178+
- MCP工具使用
179+
- 页面搭建场景
180+
- 学习/知识型场景
181+
182+
点击任一提示项可以快速发送对应的示例问题。
183+
184+
### 6.3 Markdown 支持
185+
186+
AI 助手支持 Markdown 格式的消息渲染,可以更好地展示:
187+
- 代码片段
188+
- 表格
189+
- 列表
190+
- 等其他富文本内容
191+
192+
### 6.4 全屏模式
193+
194+
点击右上角的展开按钮,可以进入全屏模式,获得更大的对话空间。
195+
196+
![全屏模式](./imgs/ai-assistant-fullscreen.png)
197+
198+
## 七、注意事项
199+
200+
1. **保存提醒**:在使用AI插件前,请确保当前页面或区块已保存
201+
2. **网络要求**:使用AI功能需要稳定的网络连接
202+
3. **API Token**:需要配置有效的API Token才能正常使用AI功能
203+
4. **MCP工具依赖**:部分MCP工具需要相应的插件支持才能正常工作
204+
205+
## 八、故障排除
206+
207+
### 8.1 无法连接AI服务
208+
209+
- 检查网络连接是否正常
210+
- 确认API Token是否正确配置
211+
- 检查AI服务是否正常运行
212+
213+
### 8.2 MCP工具无法使用
214+
215+
- 确认相关插件是否已安装并启用
216+
- 检查MCP工具是否已启用
217+
- 查看控制台是否有错误信息
218+
219+
### 8.3 功能异常
220+
221+
- 尝试刷新页面
222+
- 清除浏览器缓存
223+
- 联系技术支持
224+
225+
通过以上介绍,您应该能够熟练使用新版AI插件的各项功能。随着平台的不断发展,AI插件将会支持更多强大的功能,帮助您更高效地进行低代码开发。

0 commit comments

Comments
 (0)