Get the FREE Ultimate OpenClaw Setup Guide →

navigator

Scanned
npx machina-cli add skill karim-bhalwani/agent-skills-collection/navigator --openclaw
Files (1)
SKILL.md
4.1 KB

Navigator Skill - Filesystem & Logic Discovery

Overview

The Navigator skill is the "GPS and Surveyor" of the codebase. It helps understand "where things are" and "how they work" before any changes are made.

Core Capabilities

1. Filesystem Scouting (Locator)

  • Discovery: Use find_by_name and list_dir to map directory structures.
  • Symbol Search: Use grep_search to find classes, functions, or specific strings across the project.
  • Context Extraction: Identify relevant files for a specific feature or bug without reading entire contents.

2. Logic Analysis (Analyzer)

  • Execution Tracing: Map data flows from entry points to persistence.
  • Dependency Analysis: Identify what a module relies on and what relies on it.
  • Integration Seams: Pinpoint the exact location where a new feature should be injected or a bug fix should be applied.

Workflow

  1. Locate: Find all files related to the user's request using naming conventions and content searches.
  2. Read & Trace: Ingest the relevant files and follow imports/calls to understand the chain of command.
  3. Explain: Summarize the logic in plain English for implementation planning.
  4. Handoff: Provide a clear list of files and specific line numbers for the next phase.

Output Format: Discovery Report

Every navigation task should summarize:

  • Relevant Files: List of absolute paths with a 1-sentence description of their role.
  • Logic Summary: Explanation of the current execution flow.
  • Dependency Map: Visual or text-based map of module interactions.
  • Recommended Seam: Where modifications should specifically take place.

When to Use

  • When entering a new or unfamiliar codebase.
  • Before implementation to verify "where to cut" into the code.
  • When trying to find the source of a specific error or behavior.

Outputs & Deliverables

  • Primary Output: Discovery report summarizing relevant files, logic summary, and recommended seam (plain-text or markdown)
  • Secondary Output: File list with line references and a short dependency map (Mermaid or ASCII)
  • Success Criteria: Report identifies the correct set of files and a clear recommended modification seam
  • Quality Gate: implementer or architect confirmation before changes are made

Constraints

  • NO implementation or refactoring.
  • NO writing to files.
  • DO NOT hallucinate paths. Only report what tools find.

Common Pitfalls

  • Incomplete Symbol Search: Searching for "user" finds hundreds of matches. Use more specific patterns and context to narrow results.
  • Missing File References: Not tracing all imports means some related files are missed. Follow the import chain completely.
  • Misreading Execution Flow: Assuming linear execution without understanding async/callbacks/events leads to wrong seams. Trace carefully.
  • Ignoring Circular Dependencies: Finding mutual imports indicates a design problem. Flag these as risks, not just connections.
  • Wrong Modification Point: Recommending changes at the wrong layer. Understand the full flow before suggesting "cut here".
  • Hallucinated Files: Inventing file paths that don't exist. Only report paths confirmed by directory listings and searches.

Integration Points

PhaseInput FromOutput ToContext
ExplorationUser question about codebaseDiscovery reportFind relevant files and logic flow
ValidationReport findingsimplementerConfirm modification seam is correct
ArchitectureSystem understandingarchitectProvide dependency map for design decisions
ImplementationReady-to-code stateimplementerList exact files and line numbers for changes

Source

git clone https://github.com/karim-bhalwani/agent-skills-collection/blob/main/skills/navigator/SKILL.mdView on GitHub

Overview

Navigator is the GPS and surveyor of a codebase. It helps you quickly locate where code lives, trace how execution flows across modules, and map dependencies so you can plan changes with confidence. This matters when entering unfamiliar codebases or preparing for feature injections and bug fixes.

How This Skill Works

Navigator uses discovery tools like find_by_name and list_dir to map the filesystem, and grep_search to locate classes, functions, or strings across the project. It then ingests the relevant files, follows imports and calls to reveal the execution flow and dependencies, and outputs a plain-English explanation plus a handoff with file references and line numbers.

When to Use It

  • Entering a new or unfamiliar codebase
  • Before implementation to verify where to cut into the code
  • Tracing the source of a specific error or behavior
  • Understanding module structure and dependency relationships
  • Mapping integration seams for new features or bug fixes

Quick Start

  1. Step 1: Locate files related to your request using naming conventions and grep_search
  2. Step 2: Read & trace the relevant files, following imports and function calls to map the flow
  3. Step 3: Explain the logic in plain English and prepare a handoff with file paths and line numbers

Best Practices

  • Use precise search patterns to avoid false positives (avoid generic terms like 'user' when possible)
  • Focus on the import/call chain to understand the execution path, not just individual files
  • Identify the exact modification seam before proposing changes
  • Document findings with file references and one-line role descriptions
  • Avoid hallucinated paths; only report files and paths confirmed by searches

Example Use Cases

  • Trace the authentication flow to locate where the user session is validated and where token expiration is enforced
  • Map which modules are involved in a data export feature to determine where to add a new export endpoint
  • Follow a bug report to identify the precise module and function responsible for the failing behavior
  • Identify dependencies for a new feature to assess potential side effects across services
  • Pinpoint the integration seam for injecting a feature without altering unrelated layers

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers