explore
Explore and understand an unfamiliar codebase
Explore Codebase
Help the user understand the structure and organization of an unfamiliar codebase.
Workflow
Execute the following steps:
-
Identify repository: If $ARGUMENTS is provided, use it as the repo name. Otherwise, use
list_reposto show available repositories and ask which one to explore. -
Check capabilities: Use
get_index_statusto see which features are enabled (git, call-graph, etc.) -
Get AI overview: Use
explain_codebaseto get an AI-friendly summary of the codebase -
Show structure: Use
get_project_structurewithmax_depth=3to show the directory tree -
Find main components:
- Use
find_symbolswithsymbol_type="class"to find main data structures - Use
find_symbolswithsymbol_type="function"andpattern="*main*"to find entry points
- Use
-
Understand dependencies: Use
get_import_graphto show how modules connect -
Check for issues: Use
find_circular_importsto identify potential architectural problems -
Summarize: Provide a clear summary of:
- Project structure and organization
- Key modules and their purposes
- Entry points
- Any architectural concerns (circular deps, etc.)
Arguments
Repository to explore: $ARGUMENTS