Skip to content

Commit cb5dd5c

Browse files
authored
Update README.zh-CN with Embabel Agent details (#63)
1 parent 2efebab commit cb5dd5c

File tree

1 file changed

+62
-24
lines changed

1 file changed

+62
-24
lines changed

README.zh-CN.md

Lines changed: 62 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -96,60 +96,98 @@ uvx --from git+https://github.com/embabel/project-creator.git project-creator
9696

9797
## 🆕 **Spring Boot 集成架构**
9898

99+
### **Embabel Agent Starter 指南:**
100+
101+
#### **`embabel-agent-starter`**
102+
103+
- ✅ 应用程序自定义启动模式(控制台、Web应用程序等)
104+
- ✅ 智能体的发现与注册
105+
- ✅ 在智能体平台中Bean可通过依赖注入机制供应用程序按需使用
106+
- ✅ 进度跟踪和日志记录
107+
- ✅ 开发者友好的错误处理
108+
109+
#### **`embabel-agent-starter-shell`**
110+
111+
- ✅ 交互式命令行界面
112+
- ✅ 智能体的发现与注册
113+
- ✅ 人机交互能力
114+
- ✅ 进度跟踪和日志记录
115+
- ✅ 开发者友好的错误处理
116+
117+
#### **`embabel-agent-starter-mcpserver`**
118+
119+
- ✅ MCP协议服务器端实现
120+
- ✅ 工具的注册与发现
121+
- ✅ 通过SSE协议(服务器发送事件)进行JSON-RPC通信
122+
- ✅ 与MCP兼容的客户端集成
123+
- ✅ 安全性与沙箱化
124+
125+
99126
### **三种应用模式**
100-
Embabel Agent框架通过专门的启动类提供三种不同的应用模式:
127+
128+
Embabel Agent框架提供三种不同的应用模式,每种模式都针对不同的用例进行了优化:
129+
130+
1. 交互式Shell模式(带星球大战主题日志)
131+
```xml
132+
<dependency>
133+
<groupId>com.embabel.agent</groupId>
134+
<artifactId>embabel-agent-starter-shell</artifactId>
135+
</dependency>
136+
```
137+
101138
```kotlin
102-
// 1. 交互式 Shell 模式,带有星球大战主题的日志
103139
@SpringBootApplication
104-
@EnableAgentShell
105140
@EnableAgents(loggingTheme = LoggingThemes.STAR_WARS)
106141
class AgentShellApplication
142+
```
107143

108-
// 2. 带有 MCP 客户端支持的 Shell 模式(Docker Desktop 集成)
144+
2. Shell模式(支持MCP客户端,Docker Desktop集成)
145+
146+
```xml
147+
<dependency>
148+
<groupId>com.embabel.agent</groupId>
149+
<artifactId>embabel-agent-starter-shell</artifactId>
150+
</dependency>
151+
```
152+
153+
```kotlin
109154
@SpringBootApplication
110-
@EnableAgentShell
111155
@EnableAgents(
112-
loggingTheme = LoggingThemes.SEVERANCE,
113-
mcpServers = [McpServers.DOCKER_DESKTOP]
156+
loggingTheme = LoggingThemes.SEVERANCE,
157+
mcpServers = [McpServers.DOCKER_DESKTOP]
114158
)
115159
class AgentShellMcpClientApplication
160+
```
161+
162+
3. MCP服务器模式
163+
```xml
164+
<dependency>
165+
<groupId>com.embabel.agent</groupId>
166+
<artifactId>embabel-agent-starter-mcpserver</artifactId>
167+
</dependency>
168+
```
116169

117-
// 3. MCP 服务器模式
170+
```kotlin
118171
@SpringBootApplication
119-
@EnableAgentMcpServer
120172
@EnableAgents(mcpServers = [McpServers.DOCKER_DESKTOP])
121173
class AgentMcpServerApplication
122174
```
175+
123176
```java
124177
// Java 版本
125178
@SpringBootApplication
126-
@EnableAgentShell
127179
@EnableAgents(
128180
loggingTheme = LoggingThemes.STAR_WARS,
129181
mcpServers = {McpServers.DOCKER_DESKTOP}
130182
)
131183
public class AgentShellApplication;
132184

133185
@SpringBootApplication
134-
@EnableAgentMcpServer
135186
@EnableAgents(mcpServers = {McpServers.DOCKER_DESKTOP})
136187
public class AgentMcpApplication;
137188
```
138189

139190
### **注解指南:**
140-
#### **`@EnableAgentShell`**
141-
- ✅ 交互式命令行界面
142-
- ✅ 智能体的发现和注册
143-
- ✅ 人机协作能力
144-
- ✅ 进度跟踪和日志记录
145-
- ✅ 开发友好的错误处理
146-
147-
#### **`@EnableAgentMcpServer`**
148-
- ✅ MCP 协议服务器实现
149-
- ✅ 工具注册和发现
150-
- ✅ 通过 SSE(服务器推送事件)的 JSON-RPC 通信
151-
- ✅ 与兼容 MCP 的客户端集成
152-
- ✅ 安全性和沙箱
153191

154192
#### **`@EnableAgents`**
155193
- 🎨 **loggingTheme**:自定义智能体的日志个性

0 commit comments

Comments
 (0)