Skip to content

Commit a576e5d

Browse files
committed
docs: update README to document agents layer and plan tools from merged PRs #25 and #26
- Add Agents Layer feature: invoke_agent, read/write_agent_file, reload_agents tools - Add Plan Tools feature: plan_create, plan_update, plan_view - Add bundled subagent skills: code-interpreter and problem-solver - Document agents.directory config setting - Expand Built-in Tools section with Agent Tools and Plan Tools tables - Update Architecture section to show agents/ and new skills/ entries - Mark all three features as done in the Roadmap https://claude.ai/code/session_01U3Mm3trvmd9QitLjMG4yeT
1 parent 2796119 commit a576e5d

1 file changed

Lines changed: 32 additions & 2 deletions

File tree

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ A self-hosted, agentic Telegram AI assistant written in Rust, powered by OpenRou
2020
- **Vector Embedding Search** — Hybrid vector + FTS5 search using `qwen/qwen3-embedding-8b`
2121
- **MCP Integration** — Connect any MCP-compatible server to extend capabilities
2222
- **Bot Skills** — Folder-based natural-language skill instructions auto-loaded at startup; orchestration and subagent skills (e.g. **daily-news-to-threads**) let the main agent delegate to specialized subagents and override models per task
23+
- **Agents Layer** — Isolated agentic mini-loops in `agents/` with their own model, tool whitelist, and `AGENT.md` instructions; invoked via `invoke_agent`, with `read_agent_file`/`write_agent_file` for file I/O and `reload_agents` for hot-reloading
24+
- **Plan Tools**`plan_create`, `plan_update`, `plan_view` built-in tools let the agent create and manage structured execution plans stored in the sandbox; power the `problem-solver` subagent skill
25+
- **Bundled Subagent Skills**`code-interpreter` (executes and iterates code snippets) and `problem-solver` (orchestrates multi-step reasoning with plan tools) ship out of the box
2326
- **Agentic Loop** — Automatic multi-step tool calling until task completion (max iterations configurable, default 25)
2427
- **Per-user Conversations** — Independent conversation history per user
2528

@@ -75,6 +78,7 @@ See [`config.example.toml`](config.example.toml) for all options.
7578
| `memory.database_path` | SQLite DB path (default: `rustfox.db`) |
7679
| `embedding` (optional) | Vector search API config (default model: `qwen/qwen3-embedding-8b`) |
7780
| `skills.directory` | Folder of bot skill files (default: `skills/`) |
81+
| `agents.directory` | Folder of agent definition files (default: `agents/`) |
7882
| `mcp_servers` | List of MCP servers to connect |
7983
| `general.location` | Your location string (under `[general]`), injected into system prompt |
8084

@@ -179,6 +183,23 @@ Tools from MCP servers are automatically namespaced as `mcp_<server-name>_<tool-
179183
| `list_scheduled_tasks` | List all active scheduled tasks |
180184
| `cancel_scheduled_task` | Cancel a scheduled task by ID |
181185

186+
### Agent Tools
187+
188+
| Tool | Description |
189+
|------|-------------|
190+
| `invoke_agent` | Run an agent from the `agents/` directory in an isolated agentic loop |
191+
| `read_agent_file` | Read a file from within an agent's directory |
192+
| `write_agent_file` | Write a file into an agent's directory |
193+
| `reload_agents` | Hot-reload the agent registry without restarting the bot |
194+
195+
### Plan Tools
196+
197+
| Tool | Description |
198+
|------|-------------|
199+
| `plan_create` | Create a new structured execution plan (stored as `.rustfox_plan.json` in the sandbox) |
200+
| `plan_update` | Update a step's status or notes in the current plan |
201+
| `plan_view` | View the current plan and its step statuses |
202+
182203
## Bot Commands
183204

184205
| Command | Description |
@@ -194,13 +215,19 @@ src/
194215
├── main.rs # Entry point, config loading, initialization
195216
├── config.rs # TOML configuration parsing
196217
├── llm.rs # OpenRouter API client with tool calling
197-
├── agent.rs # Agentic loop, tool dispatch, scheduling tools
198-
├── tools.rs # Built-in tools (file I/O, command execution)
218+
├── agent.rs # Agentic loop, tool dispatch, scheduling tools; agents/ layer
219+
├── tools.rs # Built-in tools (file I/O, command execution, plan tools)
199220
├── mcp.rs # MCP client manager for external tool servers
200221
├── memory/ # SQLite persistence, vector embeddings
201222
├── scheduler/ # Cron/one-shot task scheduler with DB persistence
202223
├── skills/ # Skill loader (auto-loads from skills/ directory)
203224
└── platform/ # Telegram bot handler
225+
226+
agents/ # Agent definition files (AGENT.md per agent)
227+
skills/
228+
├── code-interpreter/ # Subagent skill: execute and iterate code snippets
229+
├── problem-solver/ # Subagent skill: multi-step reasoning with plan tools
230+
└── creating-agents/ # Instruction skill: how to author new agents
204231
```
205232

206233
## Roadmap
@@ -220,6 +247,9 @@ src/
220247
- [x] Agent skill writer (`write_skill_file` tool — creates/updates skill files from within the agent)
221248
- [x] Agent skill reload (`reload_skills` tool — hot-reloads skill registry without restart)
222249
- [x] Meta Threads MCP integration (setup wizard entry, config example, token setup guide)
250+
- [x] Agents layer (`invoke_agent`, `read_agent_file`, `write_agent_file`, `reload_agents` — isolated agentic mini-loops in `agents/` with own model and tool whitelist)
251+
- [x] Plan tools (`plan_create`, `plan_update`, `plan_view` — structured execution plans in the sandbox)
252+
- [x] Bundled subagent skills: `code-interpreter` and `problem-solver`
223253

224254
### Planned
225255

0 commit comments

Comments
 (0)