get_overview
Get an architecture map of an unfamiliar repository, including key modules, entry points, git health, and knowledge distribution. Start here when exploring a new codebase.
Instructions
Architecture map for an unfamiliar repo — first call when you don't know your way around.
Returns the synthesised overview plus key modules, entry points, repo-wide
git health (hotspot count, churn trend, bus-factor distribution), the
knowledge map (top owners, knowledge silos), and the community summary.
Skip this on subsequent calls — once you have the map, jump straight to
``get_context`` / ``get_answer``.
Compact by default: ``content_md`` carries only the overview essay's summary
section — the rest of the essay repeats ``key_modules`` / ``entry_points`` /
``architecture.layers``. Pass ``include=["content"]`` for the full essay.
In workspace mode:
- Omit ``repo`` for the default repo's overview plus a workspace footer.
- ``repo="all"`` returns the cross-repo topology (co-changes, package deps,
API contracts) — no single-repo detail.
- ``repo="<alias>"`` targets one specific repo.
Args:
repo: Repository alias, path, or ID. Use ``"all"`` for workspace overview.
include: Opt-in extras. ``"content"`` returns the full overview essay in
``content_md`` instead of the compact summary section.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| repo | No | ||
| include | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |