Explore Plugin
The Explore plugin gives the agent a single explore tool: a read-only sub-agent specialised in navigating, searching, and understanding a codebase. The main agent delegates an investigation ("where is X defined and who calls it?", "how does subsystem Y fit together?") and gets back a synthesised answer, without filling the main conversation with raw file dumps.
Configuration
plugins:
- module: codumentor.plugins.explore
class: ExplorePlugin
priority: 10
args:
enabled: true
target_agents: "main" # comma-separated agent names (default: "main")
Parameters
- enabled (optional): Whether the plugin is active (default:
true) - target_agents (optional): Which agents receive the
exploretool (default:"main") - max_iterations (optional): Maximum reasoning steps the explorer sub-agent may take before it must answer
Tool Reference
| Tool | Description |
|---|---|
explore | Investigate a codebase question via a read-only sub-agent. Takes a self-contained query (framing + hypotheses + specific questions + hints about relevant files), and an optional subagent_id to continue a previous exploration session. |
The explorer sub-agent is equipped with read-only capabilities only:
ripgrep— fast pattern search across files (when thergbinary is available)knowledge_search— semantic search over the vector knowledge base (when one is configured)file_reader— read targeted file sectionsshell— read-only shell operations (directory listings,find,head/tail,wc, …)
Notes
- Read-only by design: the explorer has no write, edit, or run tools, so it can safely range across the repository.
- It runs as a separate sub-agent and does not see the parent conversation — give it everything it needs in the
query. Reusesubagent_idto continue an earlier exploration. - Requirements: ripgrep on
PATHis recommended (the tool still loads without it); semantic search needs a vector knowledge base and is skipped whentools.disable_vector_searchis set. - For delegating to external CLI agents instead of an in-process explorer, see the External Agent plugin.