Skip to content

Commit 9c087b9

Browse files
Stewart86claude
andcommitted
docs: Update README.md to reflect agent workflow rewrite
- Add details about the adaptive orchestration architecture - Update agent descriptions with specialized worker agents - Document enhanced memory system with metadata and indexing - Add information about experimental features - Include context management system details - Update tools section with context-aware capabilities 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent b6ccf3b commit 9c087b9

File tree

1 file changed

+77
-25
lines changed

1 file changed

+77
-25
lines changed

README.md

Lines changed: 77 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,25 @@ Clara runs entirely via a command line interface. It can be used interactively o
2424

2525
## Agents
2626

27-
Clara is built using a suite of specialized agents that work together to analyze and explain code:
27+
Clara is built using an adaptive orchestration architecture with specialized agents that work together to analyze and explain code:
2828

29-
1. **Thinker Agent**: Organizes complex thoughts and outlines potential solutions.
30-
2. **Parser Agent**: Analyzes code snippets to understand structure and functionality.
31-
3. **Meme Agent**: Injects light-hearted humor through relatable programming memes.
32-
4. **Pun Agent**: Crafts programming-related puns to add a fun twist to explanations.
33-
5. **Search Agent**: Efficiently locates code patterns and files within the project.
34-
6. **Assistant Agent**: Provides comprehensive assistance by managing and coordinating the other agents.
29+
1. **Orchestrator Agent**: Coordinates the entire workflow, creating detailed execution plans with dependencies between steps. Uses OpenAI's o3-mini model for efficient planning.
3530

36-
- **End-to-End Code Investigation**: Clara methodically reads, parses, and interprets code, piecing together the logic and purpose behind every module or function.
37-
- **Layman-Friendly Explanations**: Clara transforms technical jargon into accessible language, bridging the gap between complex code logic and business strategy.
38-
- **Business-Savvy Insights**: With a strong business focus, Clara highlights how specific code components impact overall business functions and operational efficiency.
39-
- **Engaging and Casual Interaction**: Clara maintains a professional yet approachable demeanor, occasionally using humor to make technical discussions more engaging.
31+
2. **Search Agent**: Efficiently locates code patterns and files with incremental search strategies and result caching. Optimized for finding precisely what you need in large codebases.
32+
33+
3. **Memory Agent**: Manages Clara's knowledge system with automatic categorization, metadata tagging, and relationship tracking between information.
34+
35+
4. **Command Agent**: Safely executes shell commands with enhanced security validation, result parsing, and error recovery strategies.
36+
37+
5. **Verification Agent**: Validates outputs for accuracy, performs fact-checking against the codebase, and suggests corrections when issues are found.
38+
39+
6. **User Intent Agent**: Deeply analyzes requests to identify user's true objectives, implicit needs, and priority information.
40+
41+
7. **Meme Agent**: Injects light-hearted humor through relatable programming memes.
42+
43+
8. **Pun Agent**: Crafts programming-related puns to add a fun twist to explanations.
44+
45+
The agent system includes a comprehensive context management system that maintains workflow state, tracks resources, and prevents redundant operations.
4046

4147
## Prerequisites
4248

@@ -208,47 +214,71 @@ bun test:pentest
208214

209215
## Memory System
210216

211-
Clara uses a plaintext-based memory system stored in the user's home directory:
217+
Clara uses an enhanced plaintext-based memory system with structured metadata and relationship tracking:
212218

213219
- Base location: `~/.config/clara/`
214220
- Project-specific memories organized by current working directory paths
215-
- Markdown format for all stored information
221+
- Markdown format with YAML frontmatter for metadata
222+
- Advanced indexing layer for efficient search and retrieval
223+
- Relationship mapping between related memory files
216224
- Topic-based organization with folders for:
217225
- **Codebase**: Structure, patterns, conventions
218226
- **Users**: Preferences, common questions
219227
- **Insights**: Business and technical connections
220228
- **Technical**: Implementation details, architecture
221229
- **Business**: Value propositions, stakeholder impacts
222230

223-
The memory system enables Clara to provide more personalized and context-aware assistance across sessions.
231+
Each memory file includes structured metadata:
232+
```
233+
---
234+
title: Authentication Flow
235+
created: 2023-04-20T14:53:00Z
236+
updated: 2023-05-15T09:30:00Z
237+
tags: [auth, security, jwt, oauth]
238+
related: [technical/jwt.md, technical/oauth.md]
239+
summary: Overview of the authentication process using JWT tokens and OAuth 2.0
240+
importance: high
241+
---
242+
243+
# Authentication Flow
244+
245+
The authentication system uses JWT tokens with OAuth 2.0...
246+
```
247+
248+
The memory system enables Clara to maintain context across sessions, recognize relationships between topics, and provide more personalized assistance.
224249

225250
## Architecture
226251

227-
Clara is built with a multi-agent architecture:
252+
Clara is built with an adaptive orchestration architecture featuring context management:
228253

229254
### Core Components
230255

231-
- **Main Interface**: Orchestrates agents and tools, maintains conversation context
256+
- **Context Management System**: Maintains complete workflow state and history
257+
- **Orchestrator Agent**: Creates and executes plans with step dependencies
258+
- **Specialized Worker Agents**: Task-specific agents optimized for particular functions
232259
- **CLI Layer**: Parses commands and options, manages user interactions
233260

234261
### Agents
235262

236-
- **Core Clara**: Main interface and orchestration
237-
- **Thinker Agent**: Deep reasoning and complex problem solving (using OpenAI o1)
238-
- **Parser Agent**: Specialized in code understanding (using OpenAI 4o-mini)
263+
- **Orchestrator Agent**: Coordinates workflow, creates execution plans with dependency management (using OpenAI o3-mini)
264+
- **Search Agent**: Finds files and code with incremental search strategies (using OpenAI gpt-4o-mini)
265+
- **Memory Agent**: Manages knowledge with metadata tagging and relationship tracking (using OpenAI o3-mini)
266+
- **Command Agent**: Executes shell commands with security validation and result parsing (using OpenAI o3-mini)
267+
- **Verification Agent**: Validates outputs for accuracy against the codebase (using OpenAI o3-mini)
268+
- **User Intent Agent**: Analyzes requests to identify true objectives and priorities (using OpenAI o3-mini)
239269
- **Meme Agent**: Generates programming-related memes
240270
- **Pun Agent**: Creates programming puns and jokes
241-
- **Search Agent**: Specialized in finding relevant information
242271

243272
### Tools
244273

245-
Clara leverages multiple tools to interact with codebases:
274+
Clara leverages context-aware tools that maintain state across operations:
246275

247-
- **Search Tool**: Find files and code patterns with regex support
248-
- **File Reader**: Read and parse code files
249-
- **Command Tool**: Execute shell commands with security checks
250-
- **Memory Tools**: Read/write to persistent storage
276+
- **Search Tool**: Find files and code patterns with regex support, progressive search strategies, and result caching
277+
- **File Reader**: Read and parse code files with line range control
278+
- **Command Tool**: Execute shell commands with security checks and result interpretation
279+
- **Memory Tools**: Enhanced read/write to persistent storage with metadata and indexing
251280
- **Analysis Tools**: Parse code structure and relationships
281+
- **Context Tools**: Maintain and share execution state between agents
252282

253283
#### Command Security
254284

@@ -313,6 +343,28 @@ Clara is designed to be extensible with custom agents and tools:
313343
2. Implement the corresponding tool in `src/tools/`
314344
3. Register the new tool in `src/tools/index.ts`
315345

346+
### Experimental Features
347+
348+
Clara includes several experimental features that can be enabled or disabled:
349+
350+
```bash
351+
# List available experimental features
352+
clara feature list
353+
354+
# Enable a feature
355+
clara feature enable multi-agent-system
356+
357+
# Disable a feature
358+
clara feature disable memory-indexing
359+
```
360+
361+
Available experimental features:
362+
363+
- **multi-agent-system**: Enables the adaptive orchestration architecture (default: enabled)
364+
- **memory-indexing**: Enables advanced memory indexing and relationship tracking
365+
- **agent-activity**: Shows real-time agent activity in the terminal (default: enabled)
366+
- **context-sharing**: Enables context sharing between different agents (default: enabled)
367+
316368
## Troubleshooting
317369

318370
### Common Issues

0 commit comments

Comments
 (0)