PrimeNG_MCP: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

This is an MCP (Model Context Protocol) server that provides access to PrimeNG component documentation and generates Angular code examples. The server exposes tools that can be called by Claude Desktop or other MCP clients to retrieve component information, search components, and generate code snippets.

Version: 2.0.0 (Refactored Architecture)

Development Commands

Build and Run

npm run build        # Compile TypeScript to JavaScript in dist/
npm run watch        # Compile with watch mode (auto-recompile on changes)
npm run dev          # Run directly with tsx (no compilation needed)
npm start            # Run compiled version from dist/

Testing

npm test             # Run all tests with Vitest
npm run test:unit    # Run only unit tests
npm run test:coverage # Run tests with coverage report

Code Quality

npm run lint         # Lint TypeScript files
npm run lint:fix     # Auto-fix lint issues
npm run format       # Format code with Prettier
npm run format:check # Check code formatting

Architecture (v2.0)

Core Structure

The server has been refactored from a 760-line monolith into a modular architecture:

src/
├── index.ts                      # Entry point (37 lines)
├── server/
│   └── PrimeNGServer.ts         # Main server class (~180 lines)
├── services/
│   ├── ScraperService.ts        # Web scraping & HTML parsing
│   ├── CacheService.ts          # Persistent cache with TTL
│   └── CodeGeneratorService.ts  # Code generation logic
├── tools/
│   ├── BaseTool.ts              # Abstract base class for tools
│   ├── GetComponentDocTool.ts   # Tool: get_component_doc
│   ├── SearchComponentsTool.ts  # Tool: search_components
│   ├── ListComponentsTool.ts    # Tool: list_all_components
│   ├── GenerateCodeTool.ts      # Tool: generate_component_code
│   ├── GetExamplesTool.ts       # Tool: get_component_examples
│   └── index.ts                 # Tool exports
├── models/
│   ├── ComponentDoc.ts          # Interfaces and types
│   └── ToolSchemas.ts           # MCP tool schemas
├── utils/
│   ├── logger.ts                # Structured logging system
│   ├── formatters.ts            # Output formatting
│   ├── parsers.ts               # HTML parsing utilities
│   ├── errors.ts                # Custom error classes
│   └── retry.ts                 # Retry with exponential backoff
└── config/
    └── constants.ts             # Configuration and constants