Skip to content

System Architecture

High-Level Diagram

mermaid
graph TB
    usm_config["USM Config"]
    cli["USM CLI"]
    mcp["USM MCP Server"]

Technology Stack

ServiceTypeRuntimeTech Stack
USM Configapijson-config
USM CLIapinode
USM MCP Serverapinode

System Components

USM Config

  • Type: api
  • Runtime: json-config
  • Summary: The usmconfig.json shape — the project-level configuration file that drives usm init and usm scan. Defines services, shared packages, data sources, features, output paths, and LLM enrichment settings.

USM CLI

  • Type: api
  • Runtime: node
  • Summary: The USM CLI — a Commander-based Node.js CLI providing init, scan, validate, generate, enrich, scaffold, scaffold-project, roundtrip, and info commands. Entry point: src/cli/index.ts, compiled to dist/cli/index.js.

USM MCP Server

  • Type: api
  • Runtime: node
  • Summary: The USM MCP server — an stdio-based Model Context Protocol server exposing 12 tools for AI agents to navigate, search, validate, reference, and author .usm data. Entry point: src/cli/mcp.ts, compiled to dist/cli/mcp.js.