Skip to content

Commit c27ea2a

Browse files
feat: 添加快速开始文档和更新导航链接 (#26)
Co-authored-by: hh.(SII) <[email protected]>
1 parent f150224 commit c27ea2a

File tree

2 files changed

+120
-4
lines changed

2 files changed

+120
-4
lines changed

src/app/(cn)/xyzen/navigation.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,25 @@ const navigation: Array<NavGroup> = [
44
{
55
title: 'Xyzen 玄藏',
66
links: [
7-
{ title: '介绍', href: `/xyzen` }
7+
{ title: '介绍', href: `/xyzen` },
8+
{ title: '安装', href: `/xyzen/installation` },
9+
{ title: '快速开始', href: `/xyzen/quickstart` },
810
],
911
},
1012
{
11-
title: '用户指南',
13+
title: '用户手册',
1214
links: [
1315
{ title: '用户指南', href: `/xyzen/guidance` },
1416
],
1517
},
1618
{
17-
title: '部署与使用',
19+
title: 'Self-Host',
1820
links: [
1921
{ title: '部署与使用', href: `/xyzen/deploy` },
2022
],
2123
},
2224
{
23-
title: '贡献与开发',
25+
title: 'Contribution',
2426
links: [
2527
{ title: '贡献与开发', href: `/xyzen/dev` },
2628
],
Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# 快速开始
2+
3+
> 本节介绍了如何快速学会Xyzen去解决实际问题。请参阅每节中的图文内容以深入了解。
4+
5+
6+
7+
## 1、AI聊天助手
8+
9+
成功登录Xyzen平台,进入到如下界面:
10+
11+
<div style={{display: 'flex', gap: '1px', justifyContent: 'center'}}>
12+
<img src="https://storage.sciol.ac.cn/library/docs/开始新对话_night.png" alt="图片1" width="360"/>
13+
<img src="https://storage.sciol.ac.cn/library/docs/发送你好_night.png" alt="图片2" width="360"/>
14+
</div>
15+
16+
点击 `开始新对话` ,即可与聊天助手进行交互。
17+
18+
## 2、模型上下文协议(MCP)工具调用
19+
20+
**MCP工具调用是指在模型上下文中使用特定的工具或API来完成任务的过程**。以下是一个简单的示例,演示如何在Xyzen平台上添加并使用 `MCP工具`
21+
22+
### I.添加MCP服务
23+
24+
点击聊天页面右上角的MCP图标
25+
26+
<div align="center">
27+
<img src="https://storage.sciol.ac.cn/library/docs/点击MCPlogo_night.png" alt="添加MCP图" width="700"/>
28+
{/* <p><em>图1: Xyzen 聊天助手界面</em></p> */}
29+
</div>
30+
31+
进入 `MCP Servers` 窗口,点击 `Add Server` 或者 `Add Your First Server`(如果是第一次在Xyzen平台添加MCP工具)
32+
33+
<div align="center">
34+
<img src="https://storage.sciol.ac.cn/library/docs/add_first_mcp.png" alt="添加MCP图" width="700"/>
35+
{/* <p><em>图1: Xyzen 聊天助手界面</em></p> */}
36+
</div>
37+
38+
依次添加 `Server Name``Description` (可选)和 `Server URL` ,点击右下角 `Add Server` 按钮,即可完成MCP服务的添加。其中 `Server URL` 为本地启动的Xyzen服务对应的端口+xyzen/mcp/mcptools。
39+
<Note>注意:mcptools对应的python脚本要置于Xyzen/service/handler/mcp目录下。</Note>
40+
41+
<div style={{display: 'flex', gap: '1px', justifyContent: 'center'}}>
42+
<img src="https://storage.sciol.ac.cn/library/docs/add_mcp_server_night.png" alt="添加MCP样例" width="360"/>
43+
<img src="https://storage.sciol.ac.cn/library/docs/online_offline.png" alt="首个MCP工具" width="360"/>
44+
</div>
45+
绿色 `Online` 即为成功添加MCP工具(如test);若为红色 `Offline` (如pytorch1),尝试点击右上角Refresh或刷新浏览器当前页面,如果刷新不能解决 `Offline`,建议检查端口号、路径名称、MCP工具脚本是否正确,重新添加`MCP server`
46+
### II.调用MCP工具
47+
以较为简单的整型数加法为例展示如何调用已添加的MCP Server,点击页面右半栏左上角的`助手``+添加助手`,进入`添加新助手`窗口:
48+
<div style={{display:'flex', gap:'1px', justifyContent: 'center'}}>
49+
<img src="https://storage.sciol.ac.cn/library/docs/添加助手_night.png" alt="添加助手" width="210"/>
50+
<img src="https://storage.sciol.ac.cn/library/docs/加法求解器助手.png" alt="创建助手" width="330"/>
51+
<img src="https://storage.sciol.ac.cn/library/docs/助手添加完成_night.png" alt="助手添加完成" width="210"/>
52+
{/* <p><em>图1: Xyzen 聊天助手界面</em></p> */}
53+
</div>
54+
输入`名称`(必填项)、`描述``系统提示`并勾选下方”连接的MCP服务器“中需要添加的 MCPtool,点击`创建助手`按钮,完成助手的创建。
55+
#### **与新助手聊天**
56+
返回助手页面,点击刚刚创建的助手"例如:加法求解器"进入聊天页面,在对话框中输入"计算 123 + 456"的指令,点击发送按钮:
57+
58+
<div style={{display: 'flex', gap: '20px', justifyContent: 'center', alignItems: 'flex-start', flexWrap: 'wrap'}}>
59+
<div style={{flex: 1, minWidth: '300px', maxWidth: '45%'}}>
60+
<video width="100%" controls>
61+
<source src="https://storage.sciol.ac.cn/library/docs/加法求解器_night.mov" type="video/mp4" />
62+
您的浏览器不支持视频标签。
63+
</video>
64+
<p style={{textAlign: 'center', marginTop: '8px', fontSize: '14px', color: '#666'}}>
65+
<em>默认MCP工具调用演示</em>
66+
</p>
67+
</div>
68+
69+
<div style={{flex: 1, minWidth: '300px', maxWidth: '45%'}}>
70+
<video width="100%" controls>
71+
<source src="https://storage.sciol.ac.cn/library/docs/勾选MCP确认.mov" type="video/mp4" />
72+
您的浏览器不支持视频标签。
73+
</video>
74+
<p style={{textAlign: 'center', marginTop: '8px', fontSize: '14px', color: '#666'}}>
75+
<em>开启MCP工具使用确认功能</em>
76+
</p>
77+
</div>
78+
</div>
79+
80+
{/*
81+
<StackedVideosLayout
82+
title="MCP工具演示"
83+
videos={[
84+
{
85+
src: "https://storage.sciol.ac.cn/library/docs/mcptool-计算加法.mov",
86+
alt: "加法求解器"
87+
}
88+
]}
89+
/>
90+
*/}
91+
#### **开启工具使用确认**
92+
如果你希望模型在调用MCP工具前进行确认,可以在聊天输入框的左上角点击盾牌图标。如下图所示:
93+
<div style={{display:'flex', gap: '1px', justifyContent: 'center'}}>
94+
<img src="https://storage.sciol.ac.cn/library/docs/勾选MCP使用确认.png" alt="开启工具使用确认" width="400"/>
95+
<img src="https://storage.sciol.ac.cn/library/docs/确认执行MCP工具.png" alt="开启工具使用确认_highlight" width="220"/>
96+
<img src="https://storage.sciol.ac.cn/library/docs/MCP工具内部执行结果.png" alt="开启工具使用确认" width="160"/>
97+
{/* <p><em>图1: Xyzen 聊天助手界面</em></p> */}
98+
</div>
99+
{/*
100+
<StackedVideosLayout
101+
title="开启MCP工具使用确认功能"
102+
videos={[
103+
{
104+
src: "https://storage.sciol.ac.cn/library/docs/勾选MCP工具确认.mov",
105+
alt: "开启工具使用确认"
106+
}
107+
]}
108+
/>
109+
*/}
110+
与直接开始聊天不同,此时模型会在调用MCP工具前请用户确认使用哪些MCP工具,点击 `确认执行` 即可调用某个或某些MCP工具完成指定任务,避免不同种类的MCP工具之间互相干扰,影响模型回答的效果。
111+
112+
<Note>
113+
细心观察两个视频可以发现,开启 **MCP工具使用确认功能** 前后,工具的内部执行操作和结果是相同的。
114+
</Note>

0 commit comments

Comments
 (0)