Skip to content

Commit c444200

Browse files
authored
📝 Add user guide docs
2 parents e34559f + 823172c commit c444200

File tree

67 files changed

+1194
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+1194
-0
lines changed

doc/docs/.vitepress/config.mts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@ export default defineConfig({
3434
{ text: 'FAQ', link: '/en/getting-started/faq' }
3535
]
3636
},
37+
{
38+
text: 'User Guide',
39+
items: [
40+
{ text: 'Quick Start', link: '/en/user-guide/' },
41+
{ text: 'App Configuration', link: '/en/user-guide/app-configuration' },
42+
{ text: 'Model Configuration', link: '/en/user-guide/model-configuration' },
43+
{ text: 'Knowledge Base Configuration', link: '/en/user-guide/knowledge-base-configuration' },
44+
{ text: 'Agent Configuration', link: '/en/user-guide/agent-configuration' },
45+
{ text: 'Chat Interface', link: '/en/user-guide/chat-interface' }
46+
]
47+
},
3748
{
3849
text: 'SDK Documentation',
3950
items: [
@@ -135,6 +146,17 @@ export default defineConfig({
135146
{ text: '常见问题', link: '/zh/getting-started/faq' }
136147
]
137148
},
149+
{
150+
text: '用户指南',
151+
items: [
152+
{ text: '快速开始', link: '/zh/user-guide/' },
153+
{ text: '应用配置', link: '/zh/user-guide/app-configuration' },
154+
{ text: '模型配置', link: '/zh/user-guide/model-configuration' },
155+
{ text: '知识库配置', link: '/zh/user-guide/knowledge-base-configuration' },
156+
{ text: '智能体配置', link: '/zh/user-guide/agent-configuration' },
157+
{ text: '对话页面', link: '/zh/user-guide/chat-interface' }
158+
]
159+
},
138160
{
139161
text: 'SDK 文档',
140162
items: [
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Agent Configuration
2+
3+
In the Agent Configuration module, you can create, configure, and manage agents. Agents are the core feature of Nexent—they can understand your needs and perform corresponding tasks.
4+
5+
## 🛠️ Agent Management
6+
7+
### Create an Agent
8+
9+
On the Agent Management tab, click "Create Agent" to create a new blank agent. Click "Exit Create" to leave creation mode.
10+
11+
If you have an existing agent configuration, you can also import it:
12+
1. Click "Import Agent"
13+
2. In the popup, select the agent configuration file (JSON format)
14+
3. Click "Open"; the system will validate the file format and content, and display the imported agent information
15+
16+
<div style="display: flex; justify-content: left;">
17+
<img src="./assets/agent/import.png" style="width: 80%; height: auto;" />
18+
</div>
19+
20+
### Agent List
21+
22+
On the Agent Management tab, you can view all created agents. Click an agent to select it for detailed configuration; click again to deselect.
23+
24+
## 👥 Configure Agent Capabilities
25+
26+
You can configure other collaborative agents for your created agent, as well as assign available tools to empower the agent to complete complex tasks.
27+
28+
### Collaborative Agents
29+
30+
1. Click the plus sign under the "Collaborative Agent" tab to open the selectable agent list
31+
2. Select the agents you want to add from the dropdown
32+
3. Multiple collaborative agents can be selected
33+
4. Click × to remove an agent from the selection
34+
35+
<div style="display: flex; justify-content: left;">
36+
<img src="./assets/agent/set-collaboration.png" style="width: 50%; height: auto;" />
37+
</div>
38+
39+
### Select Tools
40+
41+
Agents can use various tools to complete tasks, such as knowledge base search, email sending, file management, and more. They can also integrate third-party MCP tools or custom tools.
42+
43+
1. On the "Select Tools" tab, click "Refresh Tools" to update the available tool list
44+
2. Select the group containing the tool you want to add
45+
3. View all available tools under the group; click the gear icon to view tool details and configure parameters
46+
4. Click the tool name to select/deselect it
47+
48+
<div style="display: flex; justify-content: left;">
49+
<img src="./assets/agent/set-tool.png" style="width: 50%; height: auto;" />
50+
</div>
51+
52+
### Add MCP Tools
53+
54+
Nexent allows you to quickly use third-party MCP tools to enrich agent capabilities.
55+
56+
1. On the "Select Tools" tab, click "MCP Config" to configure MCP servers in the popup and view configured servers
57+
2. Enter the server name and URL (currently only SSE protocol is supported)
58+
3. Click "Add" to complete the addition
59+
60+
<div style="display: flex; justify-content: left;">
61+
<img src="./assets/agent/mcp.png" style="width: 80%; height: auto;" />
62+
</div>
63+
64+
Many third-party services such as ModelScope provide MCP services, which you can quickly integrate and use.
65+
66+
### Custom Tools
67+
68+
You can refer to the following guides to develop your own tools and integrate them into Nexent to enrich agent capabilities:
69+
- [LangChain Tools Guide](../backend/tools/langchain)
70+
- [MCP Tool Development](../backend/tools/mcp)
71+
- [SDK Tool Documentation](../sdk/core/tools)
72+
73+
## 📝 Describe Business Logic
74+
75+
### Describe How should this Agent Work
76+
77+
Based on the selected collaborative agents and tools, you can now use concise language to describe how you want this agent to work. Nexent will automatically generate the agent’s name, description, and prompt suggestions based on your configuration and description.
78+
79+
1. In the "Describe should this agent work" editor, enter a brief description
80+
2. Click "Generate"; Nexent will generate detailed agent content for you
81+
3. You can further edit the generated content for fine-tuning
82+
83+
<div style="display: flex; justify-content: left;">
84+
<img src="./assets/agent/generate-agent.png" style="width: 50%; height: auto;" />
85+
</div>
86+
87+
### Debug Agent
88+
89+
After completing the initial agent configuration, you can debug the agent and optimize its configuration based on the results to continuously improve agent performance.
90+
91+
1. In the lower right corner of the page, click the "Debug" button to open the agent debug page
92+
2. Test conversations with the agent and observe its responses and behavior
93+
3. Review conversation performance and error messages, and optimize the agent configuration based on the results
94+
95+
### Manage Agents
96+
97+
- **Save:** After successful debugging, click the "Save" button in the lower right corner to save the agent. The agent will then be available for selection in the chat page.
98+
- **Export:** Export the successfully debugged agent configuration as a JSON file. When creating an agent, you can use this JSON file to create a copy via import.
99+
- **Delete:** Delete the agent (use with caution)
100+
101+
## 🚀 Next Steps
102+
103+
After completing agent configuration, you can click "Complete Setup" to proceed to:
104+
105+
1. **[Chat Interface](./chat-interface)** – Interact with your agent
106+
107+
If you encounter any issues during agent configuration, please refer to our **[FAQ](../getting-started/faq)** or join our [Discord community](https://discord.gg/tb5H3S3wyv) for support.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# App Configuration
2+
3+
In the App Configuration module, you can configure the basic information of your application, including the app icon, name, and description. Proper configuration helps improve the app’s recognition and user experience.
4+
5+
- The app icon and name will be displayed in the upper left corner of the chat page, helping users quickly identify the current app.
6+
- The app description is provided to the model as background information when generating agents, enhancing the model’s understanding of the application scenario.
7+
8+
## 🖼️ App Icon Configuration
9+
10+
Click the app icon to configure it. Nexent provides two ways to set the icon:
11+
12+
- **Use a preset icon:** Select from the built-in icon library, choose an image and background color for quick setup.
13+
- **Upload a custom image:** Supports PNG and JPG formats, with a file size limit of 2MB.
14+
15+
<div style="display: flex; gap: 8px;">
16+
<img src="./assets/app/predefined-app-icon-setting.png" style="width: 50%; height: 100%;" />
17+
<img src="./assets/app/customized-app-icon-setting.png" style="width: 50%; height: 80%;" />
18+
</div>
19+
20+
## 📝 App Name & Description Configuration
21+
22+
### App Name
23+
24+
- The app name is displayed in the upper left corner of the chat page, helping users quickly identify the current app.
25+
- It is recommended to use a concise and clear name that reflects the app’s functionality. Avoid using special characters.
26+
27+
### App Description
28+
29+
- The app description is provided to the model as background information, helping it understand the application scenario.
30+
- Highlight the core features of the app, and keep the description complete, fluent, and concise.
31+
32+
<div style="display: flex; justify-content: left;">
33+
<img src="./assets/app/app-name-description-setting.png" style="width: 50%; height: auto;" />
34+
</div>
35+
36+
## 🚀 Next Steps
37+
38+
After completing the app configuration, we recommend you continue with:
39+
40+
1. **[Model Configuration](./model-configuration)** – Connect the AI models you need
41+
2. **[Knowledge Base Configuration](./knowledge-base-configuration)** – Create and manage knowledge bases
42+
3. **[Agent Configuration](./agent-configuration)** – Create and configure agents
43+
44+
If you encounter any issues during configuration, please refer to our **[FAQ](../getting-started/faq)** or join our [Discord community](https://discord.gg/tb5H3S3wyv) for support.
39.8 KB
Loading
88.1 KB
Loading
30.4 KB
Loading
13.1 KB
Loading
19.6 KB
Loading
58.6 KB
Loading
32 KB
Loading

0 commit comments

Comments
 (0)