Skip to content

Commit 80a4f03

Browse files
authored
📝 Added terminal tool user guide in Chinese and English #1234
2 parents 598b8a3 + 917dfba commit 80a4f03

File tree

11 files changed

+998
-2
lines changed

11 files changed

+998
-2
lines changed

doc/docs/.vitepress/config.mts

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,14 @@ export default defineConfig({
4848
{ text: 'Knowledge Base Configuration', link: '/en/user-guide/knowledge-base-configuration' },
4949
{ text: 'Agent Configuration', link: '/en/user-guide/agent-configuration' },
5050
{ text: 'Chat Interface', link: '/en/user-guide/chat-interface' },
51-
{ text: 'Memory Configuration', link: '/en/user-guide/memory' }
51+
{ text: 'Memory Configuration', link: '/en/user-guide/memory' },
52+
{
53+
text: 'Local Tools',
54+
items: [
55+
{ text: 'Local Tools Overview', link: '/en/user-guide/local-tools/' },
56+
{ text: 'Terminal Tool', link: '/en/user-guide/local-tools/terminal-tool' }
57+
]
58+
}
5259
]
5360
},
5461
{
@@ -168,7 +175,14 @@ export default defineConfig({
168175
{ text: '知识库配置', link: '/zh/user-guide/knowledge-base-configuration' },
169176
{ text: '智能体配置', link: '/zh/user-guide/agent-configuration' },
170177
{ text: '对话页面', link: '/zh/user-guide/chat-interface' },
171-
{ text: '记忆配置', link: '/zh/user-guide/memory' }
178+
{ text: '记忆配置', link: '/zh/user-guide/memory' },
179+
{
180+
text: '本地工具',
181+
items: [
182+
{ text: '本地工具概览', link: '/zh/user-guide/local-tools/' },
183+
{ text: 'Terminal工具', link: '/zh/user-guide/local-tools/terminal-tool' }
184+
]
185+
}
172186
]
173187
},
174188
{
27.8 KB
Loading
50.1 KB
Loading

doc/docs/en/user-guide/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Ready to get started? We recommend configuring in the following order:
2727
4. After that, configure **[Agent Configuration](./agent-configuration)** to create your own agent.
2828
5. Once everything is set, you can interact with your agent on the **[Chat Interface](./chat-interface)**.
2929

30+
## 🛠️ Local Tools
31+
32+
Nexent provides a rich set of local tools to help agents complete various complex tasks. The following introduces some tools that have certain operational difficulty:
33+
34+
- **[Terminal Tool](./local-tools/terminal-tool)**: Execute commands on remote servers through SSH connections, enabling server management and system monitoring
35+
3036
## 🧠 Advanced Features
3137

3238
Beyond basic configuration, Nexent also provides powerful advanced features:
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Local Tools
2+
3+
The Nexent platform provides a rich set of local tools that help agents complete various system-level tasks and local operations. These tools provide agents with powerful execution capabilities through direct interaction with local systems or remote servers.
4+
5+
## 🛠️ Available Tools
6+
7+
### Terminal Tool
8+
9+
**[Terminal Tool](./terminal-tool)** is one of the core local tools of the Nexent platform, allowing agents to execute commands on remote servers through SSH connections.
10+
11+
**Key Features**:
12+
- Remote server management
13+
- System monitoring and status checking
14+
- File operations and directory management
15+
- Service start/stop and configuration management
16+
- Log viewing and analysis
17+
18+
**Use Cases**:
19+
- Server operations automation
20+
- System monitoring and alerting
21+
- Batch file processing
22+
- Deployment and release management
23+
- Troubleshooting and diagnostics
24+
25+
## 🔧 Tool Configuration
26+
27+
All local tools need to be configured in the agent configuration:
28+
29+
1. Navigate to the **[Agent Configuration](../agent-configuration)** page
30+
2. Select the agent to configure
31+
3. Find the corresponding local tool in the "Select Agent Tools" tab
32+
4. Click the configuration button and fill in the necessary connection parameters
33+
5. Test the connection to ensure configuration is correct
34+
6. Save the configuration and enable the tool
35+
36+
## ⚠️ Security Considerations
37+
38+
When using local tools, please pay attention to the following security considerations:
39+
40+
- **Permission Control**: Create dedicated users for tools, follow the principle of least privilege
41+
- **Network Security**: Use VPN or IP whitelist to restrict access
42+
- **Authentication Security**: Prefer key-based authentication, regularly rotate keys
43+
- **Command Restrictions**: Configure command whitelist in production environments
44+
- **Audit Logging**: Enable detailed operation logging
45+
46+
## 🚀 Next Steps
47+
48+
After configuring local tools, you can:
49+
50+
1. **[Agent Configuration](../agent-configuration)** - Add tools to agents
51+
2. **[Chat Interface](../chat-interface)** - Use tools through agents to execute tasks
52+
53+
If you encounter any issues while using local tools, please refer to the detailed documentation of the corresponding tool or join our [Discord Community](https://discord.gg/tb5H3S3wyv) for support.

0 commit comments

Comments
 (0)