Generates Mermaid flowchart diagrams from code call graphs, with both standard visualization and LLM-optimized token-efficient formats for AI analysis
Analyzes Python codebases using AST parsing to extract function metadata, build call graphs, and provide semantic search capabilities
Provides code analysis capabilities for TypeScript projects, including AST parsing and call graph generation
CodeFlow: Cognitive Load Optimized Code Analysis Tool
Overview
CodeFlow is a powerful Python-based code analysis tool designed to help developers and autonomous agents understand complex codebases with minimal cognitive overhead. It generates detailed call graphs, identifies critical code elements, and provides semantic search capabilities, all while adhering to principles that prioritize human comprehension.
By extracting rich metadata from Abstract Syntax Trees (ASTs) and leveraging a persistent vector store (ChromaDB), CodeFlow enables efficient querying and visualization of code structure and behavior.
The tool provides three main interfaces:
CLI Tool: A command-line interface for direct analysis and querying of codebases.
MCP Server: A Model Context Protocol server that integrates with AI assistants and IDEs for real-time code analysis.
Unified API: A single programmatic interface that automatically detects and analyzes both Python and TypeScript codebases.
Features
Core Analysis Capabilities
Deep AST Metadata Extraction (Python & TypeScript): Gathers comprehensive details about functions and classes including:
Parameters, return types, docstrings
Cyclomatic complexity and Non-Comment Lines of Code (NLOC)
Applied decorators (e.g.,
@app.route
,@transactional
)Explicitly caught exceptions
Locally declared variables
Inferred external library/module dependencies
Source body hash for efficient change detection
Unified Interface: Single API that automatically detects and analyzes both Python and TypeScript codebases without manual language specification.
Intelligent Call Graph Generation:
Builds a graph of function-to-function calls.
Employs multiple heuristics to identify potential entry points in the codebase.
Persistent Vector Store (ChromaDB):
Stores all extracted code elements and call edges as semantic embeddings.
Enables rapid semantic search and filtered queries over the codebase's functions and their metadata.
Persists analysis results to disk, allowing instant querying of previously analyzed projects without re-parsing.
Automatic Cleanup: Background process removes stale references to deleted files, keeping the index accurate and efficient.
Visualization and Output
Mermaid Diagram Visualization:
Generates text-based Mermaid Flowchart syntax for call graphs.
Highlights functions relevant to a semantic query.
Includes an LLM-optimized mode for concise, token-efficient graph representations suitable for Large Language Model ingestion, providing clear aliases and FQN mappings.
MCP Server Features
Real-time Analysis: File watching with incremental updates for dynamic codebases.
Background Maintenance: Automatic cleanup of stale file references in the vector store to maintain index accuracy.
Tool-based API: Exposes analysis capabilities through MCP tools for AI assistants.
Session Context: Maintains per-session state for complex analysis workflows.
Comprehensive Tools: Semantic search, call graph generation, function metadata retrieval, entry point identification, and Mermaid graph generation.
CLI Tool Features
Batch Analysis: Complete codebase analysis with report generation.
Interactive Querying: Semantic search against analyzed codebases.
Flexible Output: JSON reports, Mermaid diagrams, and console output.
Incremental Updates: Query existing analyses without full re-processing.
Cognitive Load Optimization
Designed with principles to make the tool's output and its own codebase easy to understand and use.
Mental Model Simplicity: Clear, predictable patterns in code and output.
Explicit Behavior: Favor clarity over brevity, making implicit actions visible (e.g., decorators).
Information Hiding & Locality: Well-defined modules, keeping related code together.
Minimal Background Knowledge: Self-describing data, common patterns, reduced need for memorization.
Strategic Abstraction: Layers introduced only when they genuinely reduce overall complexity.
Linear Understanding: Code and output structured for easy top-to-bottom reading.
Comparison
System | Project Size | Indexing Time |
RooCode | 40k LOC | 2.2 min |
CodeFlow | 40k LOC | 8.6s |
Requirements
Before running CodeFlow, ensure you have Python 3.8+ and the following dependencies installed:
Installation
From Source
Clone the repository and install dependencies:
This will install the package in editable mode and make both the CLI tool and MCP server available.
CLI Tool
The CLI tool is available as a module:
MCP Server
The MCP server is available as a script:
Usage
CLI Tool
The code_flow_graph.cli.code_flow_graph
module is the main entry point for command-line analysis. All commands start with:
python -m code_flow_graph.cli.code_flow_graph [YOUR_CODE_DIRECTORY]
Replace [YOUR_CODE_DIRECTORY]
with the path to your project. If omitted, the current directory (.
) will be used.
1. Analyze a Codebase and Generate a Report
This command will parse your codebase, build the call graph, populate the ChromaDB vector store (persisted in <YOUR_CODE_DIRECTORY>/code_vectors_chroma/
), and generate a JSON report. Language detection is automatic.
2. Querying the Codebase (Analysis + Query)
Run a full analysis and then immediately perform a semantic search. This will update the vector store if code has changed.
3. Querying an Existing Analysis (Query Only)
Once a codebase has been analyzed (i.e., the code_vectors_chroma/
directory exists in [YOUR_CODE_DIRECTORY]
), you can query it much faster without re-running the full analysis:
4. Generating Mermaid Call Graphs
You can generate Mermaid diagrams of the call graph for functions relevant to your query.
Standard Mermaid (for visual rendering):
The output is Mermaid syntax, which can be copied into a Mermaid viewer (e.g., VS Code extension, Mermaid.live) for visualization.
LLM-Optimized Mermaid (for AI agents):
This output is stripped of visual styling and uses short aliases for node IDs, with explicit %% Alias: ShortID = Fully.Qualified.Name
comments. This minimizes token count for LLMs while providing all necessary structural information.
Command Line Arguments
<directory>
: (Positional, optional) Path to the codebase directory (default: current directory.
). This is also the base for the persistent ChromaDB store (<directory>/code_vectors_chroma/
).--output
: Output file for the analysis report (default:code_analysis_report.json
). Only used during full analysis.--query <QUESTION>
: Perform a semantic query.--no-analyze
: (Flag) Skips AST extraction and graph building. Requires--query
. Assumes an existing vector store.--mermaid
: (Flag) Generates a Mermaid graph for query results. Requires--query
.--llm-optimized
: (Flag) Generates Mermaid graph optimized for LLM token count (removes styling). Implies--mermaid
.
Example Report Output
The code_analysis_report.json
provides a comprehensive JSON structure including a summary, identified entry points, class summaries, and a detailed call graph (functions with all metadata, and edges).
MCP Server
The MCP server provides programmatic access to CodeFlow's analysis capabilities through the Model Context Protocol. It can be integrated with AI assistants, IDEs, and other MCP-compatible tools.
Starting the Server
Start the MCP server with default configuration:
Or with a custom configuration file:
Available Tools
The server exposes the following tools through the MCP protocol:
ping
: Test server connectivitysemantic_search
: Search functions semantically using natural language queriesget_call_graph
: Retrieve call graph in JSON or Mermaid formatget_function_metadata
: Get detailed metadata for a specific functionquery_entry_points
: Get all identified entry points in the codebasegenerate_mermaid_graph
: Generate Mermaid diagram for call graph visualizationcleanup_stale_references
: Manually trigger cleanup of stale file references in the vector storeupdate_context
: Update session context with key-value pairsget_context
: Retrieve current session context
Testing with Client
Use the included client to test server functionality:
This performs a handshake and tests basic tool functionality.
Configuration
MCP Server Configuration
The MCP server uses a YAML configuration file (default: code_flow_graph/mcp_server/config/default.yaml
):
Customize these settings by creating your own config file and passing it with --config
.
TypeScript Support
CodeFlow provides comprehensive TypeScript analysis capabilities with feature parity to Python support. It can analyze TypeScript applications, extract detailed metadata, and build call graphs for various TypeScript frameworks.
Requirements
TypeScript analysis is performed using regex-based parsing with no external dependencies required. All TypeScript language features are supported through sophisticated pattern matching.
Usage Examples
Basic TypeScript Analysis
Framework-Specific Examples
Angular Application Analysis:
NestJS Application Analysis:
React TypeScript Analysis:
TypeScript-Specific Features
Type System Analysis:
Interface Detection: Identifies and extracts TypeScript interfaces and their implementations
Type Annotations: Analyzes function parameters and return types
Generic Types: Handles generic type definitions and constraints
Union/Intersection Types: Processes complex type definitions
Decorator Analysis: Detects Angular, NestJS, and custom decorators
Framework Pattern Recognition:
Angular: Component, Service, Module, Directive decorators
NestJS: Controller, Injectable, Module decorators
Express: Route handlers and middleware detection
React: Component classes and hooks detection
TypeScript Configuration
The tool automatically detects and parses tsconfig.json
for project structure information:
Supported File Types:
.ts
- TypeScript files.tsx
- TypeScript React/JSX files
Parsing Strategy
CodeFlow uses sophisticated regex-based parsing for TypeScript analysis, providing comprehensive support for:
Type annotations and generics
Classes, interfaces, and enums
Decorators and access modifiers
Framework patterns (Angular, React, NestJS, Express)
Import/export analysis
Examples
CLI Tool Examples
Basic Analysis
Semantic Search
Visualization
MCP Server Examples
Semantic Search
Get Function Metadata
Generate Call Graph
Update Context
Testing
MCP Server Tests
Run the MCP server test suite:
This includes tests for:
Server initialization and tool registration
Tool functionality (semantic search, call graphs, etc.)
Configuration loading
File watching and incremental updates
CLI Tool Testing
Test the CLI tool by running analysis on the test files:
Integration Testing
Use the client script for end-to-end testing:
This tests the MCP protocol handshake and basic tool interactions.
Unified API
For programmatic access, CodeFlow provides a unified interface that automatically detects and analyzes both Python and TypeScript codebases:
The unified interface provides:
Automatic Language Detection: No need to manually specify Python vs TypeScript
Factory Pattern:
create_extractor()
returns appropriate extractor for file typeConsistent API: Same functions work for both languages
Clean Abstraction: Hides complexity of modular structure underneath
Architecture
The tool is structured into four main components, designed for clarity and maintainability:
Core Components
Unified Interface (
core/__init__.py
)Provides a single API for both Python and TypeScript codebases.
Factory functions for automatic language detection and extractor creation.
Simplifies usage by hiding complexity of modular structure.
AST Extractor (
core/ast_extractor.py
)Parses source code into Abstract Syntax Trees.
Extracts rich metadata for
FunctionElement
andClassElement
objects (complexity, decorators, dependencies, etc.).Filters files based on
.gitignore
for relevant analysis.
Call Graph Builder (
core/call_graph_builder.py
)Constructs a directed graph of function calls based on extracted AST data.
Identifies application entry points using multiple heuristics.
Provides structured
FunctionNode
andCallEdge
objects, containing the rich metadata.
Vector Store (
core/vector_store.py
)Integrates with ChromaDB for a persistent, queryable knowledge base.
Stores semantic embeddings of functions and edges, along with their detailed metadata.
Enables semantic search (
query_functions
) and efficient updates via source code hashing.
MCP Server Architecture
Server (
mcp_server/server.py
): MCP SDK-based server handling MCP protocol and tool registration.Analyzer (
mcp_server/analyzer.py
): Core analysis logic with file watching for incremental updates.Tools (
mcp_server/tools.py
): MCP tool implementations with request/response models.Configuration (
mcp_server/config/
): YAML-based configuration management.
CLI Tool Architecture
CodeGraphAnalyzer (
cli/code_flow_graph.py
): Main orchestrator for analysis pipeline.Command-line argument parsing and output formatting.
Integration with core components for analysis and querying.
Contributing
We welcome contributions! Please refer to the Contributing Guide (or similar if you create one) for details on how to get involved.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Roadmap
Enhanced TypeScript parsing and feature parity with Python.
Advanced data flow analysis (beyond simple local variables).
Integration with other visualization tools (e.g., Graphviz).
More sophisticated entry point detection for various frameworks.
Direct IDE integrations for real-time analysis and navigation.
Support for other programming languages.
Web-based UI for interactive code exploration.
Plugin system for custom analysis rules.
Recently Completed
✅ Unified Interface Module: Single API for automatic Python and TypeScript detection and analysis
✅ Factory Functions:
create_extractor()
andget_language_from_extension()
for simplified usage✅ Backward Compatibility: Existing code continues to work with new modular structure
Acknowledgments
This project is built upon the excellent work of:
Mermaid.js for diagramming.
MCP SDK for MCP server framework.
Watchdog for file monitoring.
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Enables AI assistants to analyze codebases through semantic search, call graph generation, and function metadata extraction. Provides real-time code analysis with persistent vector storage for understanding complex code structures and relationships.