Skip to content

Commit 74d3717

Browse files
committed
docs: comprehensive README update — tool count, CLI commands, tool reference, CHANGELOG
1 parent e5a5a31 commit 74d3717

2 files changed

Lines changed: 36 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/),
66
and this project adheres to [Semantic Versioning](https://semver.org/).
77

8+
## [Unreleased]
9+
10+
### Added
11+
- **Graph Export**`recon export` CLI + `recon_export` MCP tool (Mermaid/DOT, package/symbol/type/edge filters, subgraph clustering)
12+
- **PR Review**`recon review` CLI + `recon_pr_review` MCP tool (graph-aware blast radius, per-file risk 🔴🟡🟢, affected execution flows, Mermaid diagram, review priorities)
13+
- **Auto-detect semantic search** — if `@huggingface/transformers` is installed, embeddings are generated automatically during `recon index`
14+
- **Embedder pre-init on serve** — background embedder initialization for query-time hybrid search
15+
816
## [5.3.0] - 2026-03-19
917

1018
### Added

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
AI coding agents are **blind to architecture**. They grep, they guess, they break things.
3535

36-
Recon fixes this by indexing your codebase into a **knowledge graph** — functions, classes, call chains, imports, communities — and exposing it through **12 MCP tools**, **3 prompts**, and **5 resources** that any AI agent can query.
36+
Recon fixes this by indexing your codebase into a **knowledge graph** — functions, classes, call chains, imports, communities — and exposing it through **14 MCP tools**, **3 prompts**, and **5 resources** that any AI agent can query.
3737

3838
> 💡 **One command, full awareness.** Your agent gets dependency mapping, blast radius analysis, safe renames, execution flow tracing, Cypher queries, and hybrid semantic search — without reading every file.
3939
@@ -330,6 +330,14 @@ recon serve --no-index # Skip auto-indexing and file watcher
330330
recon serve --no-watch # Auto-index but disable file watcher
331331
recon serve --repo my-backend # Serve specific repo only
332332

333+
recon export # Export graph as Mermaid flowchart
334+
recon export --format dot # Export as Graphviz DOT
335+
recon export --symbol handleQuery # Ego graph around a symbol
336+
337+
recon review # PR review — blast radius + risk
338+
recon review --scope branch # Review branch diff vs main
339+
recon review --scope staged # Review staged changes only
340+
333341
recon status # Show index stats
334342
recon status --repo my-backend # Status for specific repo
335343
recon clean # Delete index
@@ -381,7 +389,7 @@ With a config file, your MCP setup stays minimal:
381389

382390
## Tool Reference
383391

384-
All 12 tools accept an optional `repo` parameter for multi-repo filtering.
392+
All 14 tools accept an optional `repo` parameter for multi-repo filtering.
385393

386394
### recon_packages
387395

@@ -483,6 +491,24 @@ Get the live status of the file watcher — active state, watched directories, u
483491
recon_watcher_status()
484492
```
485493

494+
### recon_export
495+
496+
Export the knowledge graph as a Mermaid flowchart or Graphviz DOT diagram. Filterable by package, symbol, node type, and edge type.
497+
498+
```
499+
recon_export(format?: "mermaid" | "dot", package?: string, symbol?: string, depth?: number, type?: string, edges?: string, limit?: number)
500+
```
501+
502+
### recon_pr_review
503+
504+
Graph-aware PR review — analyzes code changes using the dependency graph to assess blast radius, risk, affected execution flows, and review priorities.
505+
506+
```
507+
recon_pr_review(scope?: "staged" | "unstaged" | "branch" | "all", base?: string, include_diagram?: boolean)
508+
```
509+
510+
**Risk levels:** `LOW` · `MEDIUM` · `HIGH` · `CRITICAL` — scored by direct callers, confidence tiers, and cross-community impact.
511+
486512
---
487513

488514
## MCP Resources

0 commit comments

Comments
 (0)