akseljoonas HF Staff commited on
Commit
9c4199b
·
1 Parent(s): 9fe493b

readme update

Browse files
Files changed (1) hide show
  1. agent/README.md +9 -11
agent/README.md CHANGED
@@ -9,15 +9,13 @@ Async agent loop with LiteLLM.
9
  - Session maintains state (context + tools) for possible future Context Engineering
10
  - Handlers operations like (USER_INPUT, INTERRUPT, COMPACT, UNDO, SHUTDOWN) for possible UI control
11
 
12
- ```
13
- core/
14
- ├── agent_loop.py # submission_loop + Handlers
15
- ├── session.py # Session, Event, OpType
16
- └── executor.py # ToolExecutor
17
 
18
- context_manager/
19
- └── manager.py # Message history management
20
-
21
- config.py # Config with model_name + tools
22
- utils/ # Logging, etc
23
- ```
 
 
 
9
  - Session maintains state (context + tools) for possible future Context Engineering
10
  - Handlers operations like (USER_INPUT, INTERRUPT, COMPACT, UNDO, SHUTDOWN) for possible UI control
11
 
12
+ ## Components
 
 
 
 
13
 
14
+ | Component | Purpose | Long Term Goal |
15
+ |-----------|---------|----------------|
16
+ | **`agent_loop.py`** | Core agentic loop: processes user input, calls LLM via LiteLLM, executes tool calls iteratively until completion, emits events | Support parallel tool execution, streaming responses, and advanced reasoning patterns |
17
+ | **`session.py`** | Maintains session state and interaction with potential UI (context, config, event queue), handles interrupts, assigns unique session IDs for tracing | Enable plugging in different UIs (CLI, web, API, programmatic etc.) |
18
+ | **`tools.py`** | `ToolRouter` manages potential built-in tools (e.g. bash, read_file, write_file which are dummy implementations rn) + MCP tools, converts specs to OpenAI format | Be the place for tools that can be used by the agent. All crazy tool design happens here. |
19
+ | **`context_manager/`** | Manages conversation history, very rudimentary context engineering support | Implement intelligent context engineering to keep the agent on track |
20
+ | **`config.py`** | Loads JSON config for the agent | Support different configs etc. |
21
+ | **`main.py`** | Interactive CLI with async queue architecture (submission→agent, agent→events) (simple way to interact with the agent now)| Serve as reference implementation for other UIs (web, API, programmatic) |