Skip to main content

Module tools

Module tools 

Source
Expand description

Built-in tool implementations and registry.

Re-exports§

pub use bash::BashTool;
pub use debug_tool::DebugTool;
pub use edit::EditTool;
pub use eval_tool::EvalTool;
pub use find::FindTool;
pub use grep::GrepTool;
pub use ls::LsTool;
pub use read::ReadTool;
pub use crate::mcp::McpTool;
pub use ask::AskBridge;
pub use ask::AskTool;
pub use ast_edit::AstEditTool;
pub use ast_grep::AstGrepTool;
pub use commit::CommitTool;
pub use context7::Context7QueryDocsTool;
pub use context7::Context7ResolveLibraryIdTool;
pub use memory_edit::MemoryEditTool;
pub use memory_recall::MemoryRecallTool;
pub use memory_reflect::MemoryReflectTool;
pub use memory_retain::MemoryRetainTool;
pub use subagent::SubagentTool;
pub use write::WriteTool;

Modules§

ask
Ask tool — ask the user one or more clarifying questions via the TUI overlay. Ask tool — ask the user one or more questions via the TUI overlay.
ast_edit
AST-aware structural code rewriting tool (ast-grep backed). AST-edit tool — structural code rewriting via the sg (ast-grep) CLI.
ast_grep
AST structural search tool (wraps the sg CLI).
bash
Bash shell execution tool.
browse
Browser tools (engine abstraction always compiled). Browser tools for web page rendering and data extraction.
checkpoint_tool
Checkpoint and Rewind tools — save/restore investigation state.
commit
Conventional-commit tool (deterministic scope + LLM analysis). Conventional-commit tool.
computer_tool
Computer tool — computer control using Vision AI.
context7
Context7 documentation tools. Context7 documentation tools.
debug_tool
Debug tool — DAP-backed debugger integration (scaffold). Debug tool — Debugger integration via DAP (Debug Adapter Protocol).
edit
In-place file edit tool.
edit_diff
Diff-based edit helpers.
eval_tool
Eval tool — persistent-kernel code execution (scaffold). Eval tool — execute code and capture output.
file_mutation_queue
Serialised file-mutation queue.
find
File-fsystem find tool.
generate_image
Image generation tool (OpenRouter API). Image generation tool using OpenRouter API.
github
GitHub integration tool (gh CLI-based).
github_search
GitHub repository search tool (legacy REST API).
goal_tool
Goal tool — manage investigation goals with token budgets.
grep
Content search (grep) tool.
hashline_fs
TokioHashlineFs — tokio::fs-backed HashlineFs implementation. Concrete HashlineFs backed by tokio::fs, PathGuard, and the global file_mutation_queue.
http_client
Shared HTTP client singleton. Shared HTTP client singleton for oxicode-agent tools.
hub_tool
Hub tool — agent coordination for peer messaging and job management.
inspect_image_tool
Inspect Image tool — analyze images using Vision LLM capabilities.
learn_tool
Learn tool — capture a reusable lesson to memory and optionally create a managed skill.
ls
Directory listing tool.
lsp
LSP tool (requires LspProvider capability). LSP tool — Language Server Protocol operations.
manage_skill_tool
Manage Skill tool — create, update, or delete isolated managed SKILL.md files.
memory_edit
Memory edit tool — update or delete a memory item. memory_edit tool — update or delete a memory item.
memory_recall
Memory recall tool — semantic search over stored memories. memory_recall tool — search the memory backend for relevant items.
memory_reflect
Memory reflect tool — persist a session summary to memory. memory_reflect tool — persist a session summary to memory.
memory_retain
Memory retain tool — persist a memory item to the backend. memory_retain tool — persist a memory item to the backend.
path_security
Path security (traversal protection). File path security validation.
path_utils
Path manipulation utilities.
read
File reading tool.
render_utils
Rendering utilities for tool output. Tool output rendering utilities Provides helpers for formatting tool results for display.
review_tool
Review tool — request code review with focus areas and priorities.
search_cache
Search result cache and get_search_results tool.
subagent
Sub-agent delegation tool.
todo
Phased todo tool (init/start/done/drop/rm/append/view). Todo tool — phased task management with 7 ops.
tool_definition_wrapper
Tool definition wrapper helpers.
truncate
Output truncation helpers. Output truncation utilities for tool results Limits tool output by two independent limits (lines + bytes), whichever hits first. UTF-8 safe: truncates at valid character boundaries.
tts_tool
TTS tool — text-to-speech synthesis.
vibe_tool
Vibe tool — manage persistent worker sessions.
web_search
Multi-engine web search tool (oxibrowser search module).
write
File writing tool.
yield_tool
Yield tool — subagent result submission.

Structs§

AgentInfo
Read-only agent info for Hub display.
AgentToolResult
Result of tool execution
DiagnosticsSummary
Aggregated diagnostics across one or more files (returned by LspProvider::drain_diagnostics). Counts severity buckets so callers can surface a quick “0 errors / 3 warnings” summary without scanning every diagnostic.
FileDiagnosticEntry
Diagnostics for one file. Path is the LSP document URI as the server reported it (may be file://-prefixed); diagnostics is the raw payload from textDocument/publishDiagnostics.
ForkResult
Result of an in-process isolated sub-agent fork run.
MemoryItem
A single memory item returned by MemoryBackend.
RenderOutput
Render output for TUI visualization.
ResolvedContent
Content resolved from an internal protocol URL (e.g. skill://, issue://).
ToolContext
Context passed to tools at execution time.
ToolRegistry
Tool registry for managing available tools

Enums§

AgentHubStatus
Hub display status.
AgentKind
Agent kind for Hub display.
LspAction
LSP action enum — the operations the lsp tool supports.
ToolExecutionMode
Tool execution mode for parallel safety.
ToolTier
Core trait for all agent tools Risk tier for approval gating.

Traits§

AgentPoolProvider
Agent pool access capability. Implemented by the composition root to expose live sub-agent info to the Hub overlay and todo matching.
AgentTool
Core trait for all agent tools
LspProvider
LSP access capability. Implemented by an oxicode-lsp crate (feature-gated) or stubbed with None when LSP is disabled.
MemoryBackend
Memory backend for the memory_* tools. The composition root implements this, bridging to oxicode_sdk::ports::MemoryStore + EmbeddingProvider.
SubagentRunner
In-process sub-agent runner — the library-native delegation backend.
TodoStateProvider
Todo state access capability. Implemented by the composition root (oxicode-cli) bridging to the session-scoped todo state. Used by the todo agent tool and the TUI sticky panel.
UrlResolver
URL resolver for internal protocol schemes. The composition root implements this, bridging to oxicode_sdk::ports::InternalUrlRouter.

Type Aliases§

ProgressCallback
Callback type for progress updates
ToolError
Result type for tool execution