Skip to content

Commit d87e225

Browse files
authored
Update README with Embabel Agent details (#61)
* Update README with Embabel Agent details Added Embabel Agent starter guide and application modes. * Correct IntelliJ IDEA badge in README
1 parent 9acf63b commit d87e225

File tree

1 file changed

+53
-25
lines changed

1 file changed

+53
-25
lines changed

README.md

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -108,67 +108,95 @@ if you already have an `OPENAI_API_KEY` and have Maven installed.
108108

109109
## 🆕 **Spring Boot Integration Architecture**
110110

111+
### **Embabel Agent Starter Guide:**
112+
113+
#### **`embabel-agent-starter`**
114+
115+
- ✅ Application decides on startup mode (console, web application, etc)
116+
- ✅ Agent discovery and registration
117+
- ✅ Agent Platform beans are available via Dependency Injection mechanism for Application to use as needed
118+
- ✅ Progress tracking and logging
119+
- ✅ Development-friendly error handling
120+
121+
#### **`embabel-agent-starter-shell`**
122+
123+
- ✅ Interactive command-line interface
124+
- ✅ Agent discovery and registration
125+
- ✅ Human-in-the-loop capabilities
126+
- ✅ Progress tracking and logging
127+
- ✅ Development-friendly error handling
128+
129+
#### **`embabel-agent-starter-mcpserver`**
130+
131+
- ✅ MCP protocol server implementation
132+
- ✅ Tool registration and discovery
133+
- ✅ JSON-RPC communication via SSE (Server-Sent Events)
134+
- ✅ Integration with MCP-compatible clients
135+
- ✅ Security and sandboxing
136+
111137
### **Three Application Modes**
112138

113-
The Embabel Agent framework provides three distinct application modes through dedicated starter classes:
139+
The Embabel Agent framework provides three distinct application modes, each optimized for different use cases:
140+
141+
1. Interactive Shell Mode with Star Wars themed logging
142+
```xml
143+
<dependency>
144+
<groupId>com.embabel.agent</groupId>
145+
<artifactId>embabel-agent-starter-shell</artifactId>
146+
</dependency>
147+
```
114148

115149
```kotlin
116-
// 1. Interactive Shell Mode with Star Wars themed logging
117150
@SpringBootApplication
118-
@EnableAgentShell
119151
@EnableAgents(loggingTheme = LoggingThemes.STAR_WARS)
120152
class AgentShellApplication
153+
```
121154

122-
// 2. Shell Mode with MCP Client Support (Docker Desktop integration)
155+
2. Shell Mode with MCP Client Support (Docker Desktop integration)
156+
```xml
157+
<dependency>
158+
<groupId>com.embabel.agent</groupId>
159+
<artifactId>embabel-agent-starter-shell</artifactId>
160+
</dependency>
161+
```
162+
```kotlin
123163
@SpringBootApplication
124-
@EnableAgentShell
125164
@EnableAgents(
126165
loggingTheme = LoggingThemes.SEVERANCE,
127166
mcpServers = [McpServers.DOCKER_DESKTOP]
128167
)
129168
class AgentShellMcpClientApplication
169+
```
130170

131-
// 3. MCP Server Mode
171+
3. MCP Server Mode
172+
```xml
173+
<dependency>
174+
<groupId>com.embabel.agent</groupId>
175+
<artifactId>embabel-agent-starter-mcpserver</artifactId>
176+
</dependency>
177+
```
178+
```kotlin
132179
@SpringBootApplication
133-
@EnableAgentMcpServer
134180
@EnableAgents(mcpServers = [McpServers.DOCKER_DESKTOP])
135181
class AgentMcpServerApplication
136182
```
137183

138184
```java
139185
// Java versions
140186
@SpringBootApplication
141-
@EnableAgentShell
142187
@EnableAgents(
143188
loggingTheme = LoggingThemes.STAR_WARS,
144189
mcpServers = {McpServers.DOCKER_DESKTOP}
145190
)
146191
public class AgentShellApplication
147192

148193
@SpringBootApplication
149-
@EnableAgentMcpServer
150194
@EnableAgents(mcpServers = {McpServers.DOCKER_DESKTOP})
151195
public class AgentMcpApplication
152196
```
153197

154198
### **Annotation Guide:**
155199

156-
#### **`@EnableAgentShell`**
157-
158-
- ✅ Interactive command-line interface
159-
- ✅ Agent discovery and registration
160-
- ✅ Human-in-the-loop capabilities
161-
- ✅ Progress tracking and logging
162-
- ✅ Development-friendly error handling
163-
164-
#### **`@EnableAgentMcpServer`**
165-
166-
- ✅ MCP protocol server implementation
167-
- ✅ Tool registration and discovery
168-
- ✅ JSON-RPC communication via SSE (Server-Sent Events)
169-
- ✅ Integration with MCP-compatible clients
170-
- ✅ Security and sandboxing
171-
172200
#### **`@EnableAgents`**
173201

174202
- 🎨 **loggingTheme**: Customize your agent's logging personality

0 commit comments

Comments
 (0)