# yadav-prakhar/mcp-maker architecture

> Architecture diagram of the GitHub repository yadav-prakhar/mcp-maker, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yadav-prakhar/mcp-maker
- Repository: https://github.com/yadav-prakhar/mcp-maker

## Overview

##### Project type and purpose
- MCP Maker is an open-source CLI scaffolding tool written in TypeScript.
- Its purpose is to bootstrap and manage “MCP” (Model Context Protocol) server projects by generating boilerplate code for servers, services, tools, prompts, and authentication modules.

##### File structure
- Top-level “src/” contains:
- commands/ (create, add-tool, add-service, add-prompt, add-auth, help)
- templates/ (Handlebars templates for project, tools, services, prompts, auth)
- utils/ (helpers: string manipulation, project validation, CLI output formatting)
- index.ts (CLI entry point)
- config files: tsconfig.json, .eslintrc.cjs, .prettierrc
- scripts under “.specify/” used for internal automation (pre-commit checks, context updates, scaffolding steps)

##### Core components
a. CLI Entry Point
- index.ts loads Commander.js, registers commands.
b. Command Parser & Dispatcher
- Uses Commander to parse user input and route to specific handlers.
c. Command Handlers (one per command)
- create.ts, add-tool.ts, add-service.ts, add-prompt.ts, add-auth.ts, help-*.ts
- Each invokes:
- Project Validator (ensure you’re in a valid MCP project)
- Template Engine
- File System Manager
- Utilities (string formatting, dependency updates)
d. Template Engine
- Wraps Handlebars
- Loads the correct template folder from src/templates, applies user arguments (names, options), returns generated file content.
e. File System Manager
- Wraps Node’s fs and fs-extra
- Creates directories, writes files, updates index.ts and handler registration lists.
f. Utilities
- string-utils: name formatting
- help-formatter: ANSI formatting for CLI
- validate-project: detect whether current dir is an MCP project
g. Automation Scripts (.specify)
- Separate Bash scripts to bootstrap the CLI’s own development tasks (plan updates, codegen for new commands, context updates).
h. External Dependencies
- Node.js runtime
- npm registry for installing generated project dependencies

##### Relationships & data flow
- User runs `mcp-maker <command> [options]`
↓
- CLI Entry Point (index.ts)
↓
- Command Parser dispatches to Command Handler
↓
- Handler calls Project Validator → Template Engine → File System Manager
↓
- File System writes code artifacts
↓
- CLI prints success messages via Utilities

##### Architectural patterns & principles
- Modular command-based architecture (each command lives in its own module)
- Template-driven code generation (separation of logic from templates)
- Single Responsibility modules (utilities, validators, file I/O are reused)
- Easy extensibility: new commands and templates can be added without changing core logic

##### Detail level
- Under Template Engine, note the main template folders (project, tool, service, prompt, auth).
- For File System Manager, show operations: mkdir, writeFile, appendIndex.
- In Utilities, list the key functions: validateProject(), formatHelp(), slugifyName().

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CLI Core Layer
    subgraph "CLI Core"
        CLI["CLI Entry Point"]:::cli
        Parser["Command Parser (Commander.js)"]:::cli
        subgraph "Command Handlers"
            Create["create.ts"]:::cli
            AddTool["add-tool.ts"]:::cli
            AddService["add-service.ts"]:::cli
            AddPrompt["add-prompt.ts"]:::cli
            AddAuth["add-auth.ts"]:::cli
            HelpMain["help.ts"]:::cli
            HelpCmds["help-commands.ts"]:::cli
        end
    end

    %% Template Generation Layer
    subgraph "Template Engine (Handlebars)"
        Engine["Template Engine"]:::template
        subgraph "Templates"
            ProjTpl["Project Templates"]:::template
            ToolTpl["Tool Templates"]:::template
            ServiceTpl["Service Templates"]:::template
            PromptTpl["Prompt Templates"]:::template
            AuthTpl["Auth Templates"]:::template
        end
    end

    FileSys["File System Manager (fs-extra)"]:::template

    %% Utilities Layer
    subgraph "Utilities"
        Validate["validate-project.ts"]:::util
        StringUtil["string-utils.ts"]:::util
        HelpFmt["help-formatter.ts"]:::util
    end

    %% Automation Scripts
    subgraph "Automation Scripts (.specify)"
        Scripts[".specify/scripts/bash/"]:::auto
        AutoTemplates[".specify/templates/"]:::auto
    end

    %% Connections
    CLI -->|"parse args"| Parser
    Parser -->|"dispatch command"| Create
    Parser --> AddTool
    Parser --> AddService
    Parser --> AddPrompt
    Parser --> AddAuth
    Parser --> HelpMain
    Parser --> HelpCmds

    Create -->|"validate project"| Validate
    AddTool --> Validate
    AddService --> Validate
    AddPrompt --> Validate
    AddAuth --> Validate
    HelpMain --> Validate
    HelpCmds --> Validate

    Create -->|"render template"| Engine
    AddTool --> Engine
    AddService --> Engine
    AddPrompt --> Engine
    AddAuth --> Engine

    Engine --> ProjTpl
    Engine --> ToolTpl
    Engine --> ServiceTpl
    Engine --> PromptTpl
    Engine --> AuthTpl

    Engine -->|"generated content"| FileSys
    Validate -->|"checks"| FileSys
    FileSys -->|"write files"| CLI

    Create -->|"format help"| HelpFmt
    AddTool --> HelpFmt
    AddService --> HelpFmt
    AddPrompt --> HelpFmt
    AddAuth --> HelpFmt
    HelpMain --> HelpFmt
    HelpCmds --> HelpFmt

    Create -->|"slugify names"| StringUtil
    AddTool --> StringUtil
    AddService --> StringUtil
    AddPrompt --> StringUtil
    AddAuth --> StringUtil

    CLI -->|"internal tasks"| Scripts
    CLI --> AutoTemplates

    %% Click Events
    click CLI "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/index.ts"
    click Parser "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/index.ts"
    click Create "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/commands/create.ts"
    click AddTool "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/commands/add-tool.ts"
    click AddService "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/commands/add-service.ts"
    click AddPrompt "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/commands/add-prompt.ts"
    click AddAuth "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/commands/add-auth.ts"
    click HelpMain "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/commands/help.ts"
    click HelpCmds "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/commands/help-commands.ts"

    click ProjTpl "https://github.com/yadav-prakhar/mcp-maker/tree/main/src/templates/project/"
    click ToolTpl "https://github.com/yadav-prakhar/mcp-maker/tree/main/src/templates/tool/"
    click ServiceTpl "https://github.com/yadav-prakhar/mcp-maker/tree/main/src/templates/service/"
    click PromptTpl "https://github.com/yadav-prakhar/mcp-maker/tree/main/src/templates/prompt/"
    click AuthTpl "https://github.com/yadav-prakhar/mcp-maker/tree/main/src/templates/auth/"

    click Validate "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/utils/validate-project.ts"
    click StringUtil "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/utils/string-utils.ts"
    click HelpFmt "https://github.com/yadav-prakhar/mcp-maker/blob/main/src/utils/help-formatter.ts"

    click Scripts "https://github.com/yadav-prakhar/mcp-maker/tree/main/.specify/scripts/bash/"
    click AutoTemplates "https://github.com/yadav-prakhar/mcp-maker/tree/main/.specify/templates/"

    %% Styles
    classDef cli fill:#D0E6FF,stroke:#0366D6,color:#0366D6
    classDef template fill:#E6FFEA,stroke:#28A745,color:#28A745
    classDef util fill:#FFF4E6,stroke:#E69E00,color:#E69E00
    classDef auto fill:#F0F0F0,stroke:#6A737D,color:#6A737D
```
