diff --git a/crates/tools/ask/README.md b/crates/tools/ask/README.md new file mode 100644 index 0000000..034f1ba --- /dev/null +++ b/crates/tools/ask/README.md @@ -0,0 +1,11 @@ +# Owlen Ask Tool + +Interaction tool for the Owlen AI agent to ask questions to the user. + +## Overview +This crate provides the `ask_user` tool, which allows the agent to seek clarification, confirmation, or additional information from the user through a structured interactive dialogue. + +## Features +- **Structured Questions:** Support for multiple-choice questions and free-text input. +- **Multi-select:** Allow users to select multiple options from a list. +- **Async Communication:** Uses channels for robust communication between the agent and the UI. diff --git a/crates/tools/bash/README.md b/crates/tools/bash/README.md new file mode 100644 index 0000000..b85c8fd --- /dev/null +++ b/crates/tools/bash/README.md @@ -0,0 +1,11 @@ +# Owlen Bash Tool + +Shell execution tool for the Owlen AI agent. + +## Overview +This crate enables the agent to execute bash commands in the local environment. It provides both immediate execution and long-running background shell support. + +## Features +- **Interactive Shells:** Persist shell state across multiple command invocations. +- **Background Processes:** Run commands in the background and retrieve output later. +- **Security:** Integrated with the permissions system to prevent unauthorized command execution. diff --git a/crates/tools/fs/README.md b/crates/tools/fs/README.md new file mode 100644 index 0000000..a45d625 --- /dev/null +++ b/crates/tools/fs/README.md @@ -0,0 +1,12 @@ +# Owlen Filesystem Tool + +Filesystem operation tools for the Owlen AI agent. + +## Overview +This crate provides a comprehensive set of tools for the agent to interact with the local filesystem, including reading, writing, searching, and editing files. + +## Features +- **File I/O:** Safe primitives for reading and writing file content. +- **Search:** Built-in support for `grep` and `glob` patterns. +- **Editing:** Specialized tools for precise, pattern-based file modifications. +- **Safety:** Implements automatic backups before destructive operations. diff --git a/crates/tools/notebook/README.md b/crates/tools/notebook/README.md new file mode 100644 index 0000000..ff07b35 --- /dev/null +++ b/crates/tools/notebook/README.md @@ -0,0 +1,11 @@ +# Owlen Notebook Tool + +Interactive notebook tools for the Owlen AI agent. + +## Overview +This crate enables the agent to interact with computational notebooks (e.g., Jupyter). It allows the agent to read cell contents, execute code, and view outputs. + +## Features +- **Cell Management:** Read and modify individual notebook cells. +- **Execution:** Run code cells and capture real-time output and artifacts. +- **State Awareness:** Maintain awareness of the notebook's execution state and variables. diff --git a/crates/tools/plan/README.md b/crates/tools/plan/README.md new file mode 100644 index 0000000..832995c --- /dev/null +++ b/crates/tools/plan/README.md @@ -0,0 +1,11 @@ +# Owlen Planning Tool + +Implementation planning tools for the Owlen AI agent. + +## Overview +This crate provides the infrastructure for "planning mode", where the agent can explore the codebase and draft a detailed implementation plan before making any changes. + +## Features +- **Plan Generation:** Tools to create and manage markdown-based implementation plans. +- **Mode Switching:** Primitives to transition the agent between normal and planning modes. +- **Verification:** Support for user review and approval of generated plans. diff --git a/crates/tools/skill/README.md b/crates/tools/skill/README.md new file mode 100644 index 0000000..dddb686 --- /dev/null +++ b/crates/tools/skill/README.md @@ -0,0 +1,11 @@ +# Owlen Skill Tool + +Custom skill management for the Owlen AI agent. + +## Overview +This crate allows extending the agent's capabilities with "skills" - encapsulated sets of instructions or domain-specific knowledge that can be injected into the agent's context. + +## Features +- **Skill Discovery:** Dynamically load skills from the local environment. +- **Context Injection:** Efficiently add skill-related information to the system prompt. +- **Extensibility:** Simple interface for defining new agent behaviors. diff --git a/crates/tools/slash/README.md b/crates/tools/slash/README.md new file mode 100644 index 0000000..1030209 --- /dev/null +++ b/crates/tools/slash/README.md @@ -0,0 +1,11 @@ +# Owlen Slash Command Tool + +Slash command support for the Owlen AI agent. + +## Overview +This crate enables the use of "slash commands" (e.g., `/help`, `/compact`) within the agent's chat interface. It provides a way to execute meta-commands that aren't strictly LLM tool calls. + +## Features +- **Command Parsing:** Robust parsing of slash commands and their arguments. +- **Dynamic Dispatch:** Route commands to their respective handlers. +- **Built-in Commands:** Support for common agent management tasks. diff --git a/crates/tools/task/README.md b/crates/tools/task/README.md new file mode 100644 index 0000000..899c2af --- /dev/null +++ b/crates/tools/task/README.md @@ -0,0 +1,11 @@ +# Owlen Task Tool + +Task management and orchestration for the Owlen AI agent. + +## Overview +This crate provides tools for the agent to track its progress through complex, multi-step tasks. It supports subagent orchestration and structured task state management. + +## Features +- **Task Lists:** Maintain an active list of todos and their status. +- **Subagents:** Infrastructure for spawning and managing specialized sub-agents for specific tasks. +- **Progress Tracking:** Real-time updates on task completion. diff --git a/crates/tools/todo/README.md b/crates/tools/todo/README.md new file mode 100644 index 0000000..692840d --- /dev/null +++ b/crates/tools/todo/README.md @@ -0,0 +1,11 @@ +# Owlen Todo Tool + +In-memory task list management for the Owlen AI agent. + +## Overview +This crate provides a simple, reactive todo list that the agent uses to keep track of its current objectives within a session. + +## Features +- **Thread-safe Storage:** Uses `Arc` and `RwLock` for safe concurrent access. +- **TUI Integration:** Designed to be easily rendered in the terminal interface. +- **Dynamic Updates:** Support for the `todo_write` tool to modify the list during execution. diff --git a/crates/tools/web/README.md b/crates/tools/web/README.md new file mode 100644 index 0000000..8233c41 --- /dev/null +++ b/crates/tools/web/README.md @@ -0,0 +1,11 @@ +# Owlen Web Tool + +Web search and fetching tools for the Owlen AI agent. + +## Overview +This crate enables the agent to access information from the internet. It provides tools for web searching and fetching the content of specific URLs. + +## Features +- **Search Integration:** Support for various search providers (e.g., DuckDuckGo). +- **Safe Fetching:** Controlled web page retrieval with domain filtering and redirect handling. +- **Parsing:** Built-in support for extracting clean text from HTML content.