C4Diagrammer

Generates C4 architecture diagrams and Markdown summaries from codebases to aid onboarding and navigation.

typescript

36

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "jonverrier-c4diagrammer": {
      "command": "node",
      "args": [
        "YourCodeRoot/C4Diagrammer/dist/src/index.js",
        "YourCodeRoot"
      ]
    }
  }
}

Available tools

filesystem

Lists subdirectories, reads TypeScript files, and directs generation of per-directory README and diagrams.

mcp_documenter

Tool that reads TypeScript files in a directory, creates a 50-word summary per file, and writes a README.C4Diagrammer.md in that directory.

Mermaid Engine

Processes and validates Mermaid diagrams, facilitating diagram generation and previews.

parse tool

Parses and diagnoses Mermaid/C4 diagram syntax to catch syntax errors early.

Preview Generator

Generates HTML previews of Mermaid diagrams for browser viewing.