Skip to content

Commit 3bf5886

Browse files
committed
updated agent docs
1 parent cb8c2a2 commit 3bf5886

File tree

3 files changed

+40
-30
lines changed

3 files changed

+40
-30
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,10 +280,10 @@ Execute complex, multi-step tasks autonomously with built-in issue tracking and
280280

281281
- **Issue Tracking** — Tasks broken into issues with status, priority, and dependencies
282282
- **Parallel Tasks** — Run multiple agent tasks simultaneously for increased productivity
283-
- **Execution Planning** — AI generates step-by-step plans (max 10 steps per issue)
283+
- **Reasoning Loop** — AI autonomously observes, thinks, acts, and checks in iterative cycles
284284
- **Working Directory** — Select a folder for file operations with project detection
285285
- **File Operations** — Read, write, edit, search files with undo support
286-
- **Discovery**Automatically detects errors, TODOs, and prerequisites
286+
- **Follow-up Issues**Agent creates child issues when it discovers additional work
287287
- **Clarification** — Agent pauses to ask when tasks are ambiguous
288288
- **Background Execution** — Tasks continue running after closing the window
289289

docs/AGENTS.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ The working directory determines where file operations can occur. All file paths
4040
3. The agent will:
4141
- Analyze your request
4242
- Create an initial issue
43-
- Generate an execution plan
44-
- Begin executing steps
43+
- Enter the reasoning loop, iteratively calling tools and evaluating progress
44+
- Complete the task with a summary artifact
4545

4646
---
4747

@@ -71,13 +71,14 @@ You can run **multiple tasks in parallel**, allowing you to work on different pr
7171
| **Description** | Detailed explanation and context |
7272
| **Result** | Outcome after completion |
7373

74-
### Execution Plans
74+
### Reasoning Loop
7575

76-
When working on an issue, the agent generates an **execution plan** — a step-by-step sequence of actions:
76+
When working on an issue, the agent enters a **reasoning loop** -- an iterative cycle where the model autonomously decides what to do next:
7777

78-
- Plans are bounded to **max 10 tool calls** per issue
79-
- Each step uses available tools (file operations, shell commands, etc.)
80-
- If a task is too large, it's automatically **decomposed** into subtasks
78+
- Each iteration: the model observes context, reasons about the next action, calls a tool, and evaluates progress
79+
- Loops are bounded to **max 30 iterations** per issue
80+
- The model narrates its thinking and explains actions as it works
81+
- When finished, the model calls `complete_task` to signal completion with a summary
8182

8283
### Dependencies
8384

@@ -86,18 +87,18 @@ Issues can have **dependencies** that control execution order:
8687
| Relationship | Description |
8788
| ----------------- | ------------------------------------------------ |
8889
| `blocks` | One issue must complete before another can start |
89-
| `parent_child` | Issue was decomposed from a larger issue |
90+
| `parent_child` | Child issue created from a parent task |
9091
| `discovered_from` | Issue was discovered during execution of another |
9192

92-
### Discovery
93+
### Follow-up Issues
9394

94-
During execution, the agent may **discover** additional work:
95+
During execution, the agent may discover additional work and create **follow-up issues** using the `create_issue` tool:
9596

96-
- **Errors** — Compilation errors, runtime failures
97-
- **TODOs**Code comments indicating pending work
97+
- **Bugs** — Compilation errors, runtime failures found during execution
98+
- **Related work**Additional tasks identified while working on the current issue
9899
- **Prerequisites** — Missing dependencies or setup steps
99100

100-
Discovered items become new issues automatically tracked in the issue list.
101+
Follow-up issues are automatically tracked in the issue list and linked to the originating issue.
101102

102103
---
103104

@@ -159,6 +160,15 @@ Agents have access to specialized tools for file and system operations:
159160
| `git_diff` | Display file differences |
160161
| `git_commit` | Stage and commit changes (requires permission) |
161162

163+
### Agent Control
164+
165+
| Tool | Description |
166+
| ----------------------- | ---------------------------------------------------------- |
167+
| `complete_task` | Mark the current task as complete with a summary artifact |
168+
| `create_issue` | Create a follow-up issue for discovered work |
169+
| `request_clarification` | Pause execution to ask the user a question |
170+
| `generate_artifact` | Generate a standalone document (report, analysis, etc.) |
171+
162172
All tools:
163173

164174
- Validate paths are within the working directory
@@ -254,8 +264,8 @@ This reduces token usage while maintaining access to all capabilities.
254264
│ │ │
255265
│ │ │
256266
▼ ▼ ▼
257-
Created Executing Waiting on
258-
by user plan steps dependencies
267+
Created Reasoning loop Waiting on
268+
by user iterating dependencies
259269
or agent
260270
```
261271

docs/FEATURES.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -392,23 +392,23 @@ Canonical reference for all Osaurus features, their status, and documentation.
392392
- `Agent/AgentFolderTools.swift` — File and shell operation tools
393393
- `Agent/AgentFileOperation.swift` — File operation models
394394
- `Agent/AgentFileOperationLog.swift` — Operation logging with undo support
395-
- `Models/AgentModels.swift` — Core data models (Issue, AgentTask, ExecutionPlan, etc.)
395+
- `Models/AgentModels.swift` — Core data models (Issue, AgentTask, LoopState, etc.)
396396
- `Services/AgentEngine.swift` — Main task execution coordinator
397-
- `Services/AgentExecutionEngine.swift`Plan generation and step execution
397+
- `Services/AgentExecutionEngine.swift`Reasoning loop execution engine
398398
- `Managers/IssueManager.swift` — Issue lifecycle and dependency management
399-
- `Storage/AgentDatabase.swift` — SQLite storage for issues, tasks, and events
400-
- `Tools/AgentTools.swift` — Agent-specific tools (submit_plan, report_discovery, complete_task)
399+
- `Storage/AgentDatabase.swift` — SQLite storage for issues, tasks, and conversation turns
400+
- `Tools/AgentTools.swift` — Agent-specific tools (complete_task, create_issue, generate_artifact, etc.)
401401
- `Views/AgentView.swift` — Main Agent Mode UI
402402
- `Views/AgentSession.swift` — Observable session state manager
403403

404404
**Features:**
405405

406406
- **Issue Tracking** — Tasks broken into issues with status, priority, type, and dependencies
407407
- **Parallel Tasks** — Run multiple agent tasks simultaneously for increased productivity
408-
- **Execution Planning** — AI generates step-by-step plans (max 10 tool calls per issue)
408+
- **Reasoning Loop** — AI autonomously iterates through observe-think-act-check cycles (max 30 iterations)
409409
- **Working Directory** — Select a folder for file operations with project type detection
410410
- **File Operations** — Read, write, edit, search, move, copy, delete files with undo support
411-
- **Discovery**Automatic detection of errors, TODOs, and prerequisites during execution
411+
- **Follow-up Issues**Agent creates child issues via `create_issue` tool when it discovers additional work
412412
- **Clarification** — Agent pauses to ask when tasks are ambiguous
413413
- **Background Execution** — Tasks continue running after closing the window
414414
- **Token Usage Tracking** — Monitor cumulative input/output tokens per task
@@ -443,15 +443,15 @@ Canonical reference for all Osaurus features, their status, and documentation.
443443
| `git_diff` | Display file differences |
444444
| `git_commit` | Stage and commit changes (requires permission) |
445445

446-
**Workflow:**
446+
**Workflow (Reasoning Loop):**
447447

448448
1. User input creates a task with an initial issue
449-
2. Agent generates an execution plan (max 10 steps)
450-
3. Steps are executed sequentially, calling tools as needed
451-
4. Discovery detects errors, TODOs, or prerequisites during execution
452-
5. Verification checks if goal achieved after steps complete
453-
6. Large tasks are automatically decomposed into subtasks
454-
7. Clarification pauses execution when task is ambiguous
449+
2. Agent enters a reasoning loop (max 30 iterations per issue)
450+
3. Each iteration: the model observes context, decides on an action, calls a tool, and evaluates progress
451+
4. The model narrates its reasoning and explains actions as it works
452+
5. When additional work is found, the agent creates follow-up issues via `create_issue`
453+
6. When the task is complete, the agent calls `complete_task` with a summary and artifact
454+
7. Clarification pauses execution when the task is ambiguous
455455

456456
**Storage:** `~/.osaurus/agent/agent.db` (SQLite)
457457

0 commit comments

Comments
 (0)