Installation

Prerequisites

Node.js ≥ 18 (the project is developed on Node 24)
npm (ships with Node; npx is used to run the tools)
@angular/compiler — an optional peer dependency of @cl-mcp/analyzer, required only to analyze Angular libraries or validate Angular templates. React-only setups can skip it. See Optional @angular/compiler.

Use it from npm (recommended)

The three runnable packages are published to npm as bins — run them with npx, no clone or build required:

Command	Package	What it does
`npx -y @cl-mcp/cli …`	`@cl-mcp/cli`	The `cl-mcp` CLI (query + `generate`).
`npx -y @cl-mcp/mcp-server`	`@cl-mcp/mcp-server`	The MCP server over stdio.

# generate metadata, then serve or query it
npx -y @cl-mcp/cli generate --config ./cl-mcp.yaml
CL_MCP_DATA_DIR=./data npx -y @cl-mcp/mcp-server
npx -y @cl-mcp/cli list-libraries --data-dir ./data

See Quick Start for the full walkthrough.

Develop cl-mcp from source

Only needed to work on cl-mcp itself (not to use it):

Clone & build

git clone https://github.com/marcinmilewicz/cl-mcp.git
cd cl-mcp
npm install
npm run build   # builds analyzer → core → mcp-server → cli, in order

Verify

npm test        # run the full test suite (vitest)
npm run lint    # biome

Repository scripts

Script	What it does
`npm run build`	Build all packages in dependency order.
`npm test`	Run all tests via vitest.
`npm run lint` / `npm run lint:fix`	Lint / auto-fix with Biome.
`npm run clean`	Remove `dist/` from all packages.
`npm run docs:dev`	Run this documentation site locally.
`npm run docs:build`	Build the packages, then the docs site (with the TypeDoc API reference).