Project Understanding Tool

Architecture Documenter

Auto-generate architecture documentation from code analysis. Module responsibilities, data flows, and integration points — always in sync with your code.

Get the CLI Tool

Generate architecture docs locally as an MCP server, or try it online below.

npx @clinetools/arch-doc
Requires Node.js 18+
  • Maps module responsibilities from exports, classes, and functions
  • Traces data flows through imports, function calls, and event handlers
  • Identifies integration points: APIs, databases, external services
  • Outputs markdown, Mermaid diagrams, or structured JSON
  • Preference conversation — choose detail level and output format

How to Use It

Generate architecture documentation that stays in sync with your code.

1

Try Online

Define a project structure and see generated architecture docs instantly.

2

Use via CLI

Point it at your project and get a complete architecture document.

npx @clinetools/arch-doc
3

Add to Cline / Claude Code

Agent generates docs when onboarding to projects or when architecture changes.

"arch-doc": { "command": "npx", "args": ["@clinetools/arch-doc"] }

MCP Client Configuration

{
  "mcpServers": {
    "arch-doc": {
      "command": "npx",
      "args": ["@clinetools/arch-doc"]
    }
  }
}

Preference Conversation (First Run)

// On first run, the tool asks:

1. "What detail level do you prefer?"
   [ ] Overview - high-level module map only
   [x] Standard - modules, flows, integrations
   [ ] Detailed - include function-level docs

2. "What output format?"
   [x] Markdown (ARCHITECTURE.md)
   [ ] Mermaid diagrams
   [ ] JSON (machine-readable)
   [ ] All formats

3. "What should I document?"
   [x] Module responsibilities
   [x] Data flows
   [x] External integrations
   [ ] Security boundaries
   [ ] Performance hotspots

// Preferences saved to .clinetools/arch-doc.json
Live Demo

Try It Online

Define a project structure and see generated architecture documentation.

Define Project Structure

Describe modules and their dependencies, one per line: module: description [deps: a, b]

Try a demo:

Define your project structure and click Generate Docs to create architecture documentation.

Why Architecture Docs Matter

Code tells you WHAT. Architecture docs tell you WHY. Without them, every new developer starts from zero.

Onboarding Time

Without architecture docs, new developers spend weeks reading code to understand how the system fits together. With docs, they get productive in days. The ROI on documentation is measured in hiring costs saved.

Decision Context

Architecture docs capture WHY decisions were made: "We use Redis for sessions because PostgreSQL had 200ms latency under load." Without this, the next developer replaces Redis and relearns the same lesson.

Docs Rot Prevention

Manual docs go stale within weeks. Auto-generated docs from code analysis stay accurate because they're regenerated from the source of truth: the code itself.

AI Agent Context

Architecture docs give AI agents the big picture they need. Without them, agents operate file-by-file and miss cross-cutting concerns. With docs, they understand where new code should go and what patterns to follow.

Architecture Docs That Write Themselves

Add the Architecture Documenter to your agent's toolkit and never have stale docs again.

View Plans