documentation-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

An MCP (Model Context Protocol) server that automatically generates documentation from codebase analysis. It parses TypeScript/JavaScript files using AST analysis, extracts JSDoc comments, and generates README, API documentation, Mermaid diagrams, and CHANGELOG.

Build & Development Commands

npm run build       # Compile TypeScript and copy templates to dist/
npm run dev         # Watch mode for TypeScript compilation
npm run start       # Run the compiled MCP server
npm test            # Run tests with Vitest
npm run lint        # ESLint check on src/
npm run clean       # Remove dist/ directory

Architecture

MCP Server Pattern

• Entry: src/index.ts - CLI entry point, handles doc-gen [project-path]
• Server: src/server.ts - DocumentationMCPServer class using @modelcontextprotocol/sdk, communicates via stdio transport

Tool Registry Pattern

Tools are registered in src/tools/index.ts with a Map-based registry:

registerTool(toolDefinition, handlerFunction)

Each tool file exports:

• {toolName}Tool: Tool - MCP tool definition with inputSchema
• handle{ToolName}(args, context): Promise<ToolResponse> - Handler function

Available Tools

Tool	Purpose
doc-init	Initialize .doc-generator/ with config.json and state.json
doc-status	Show current documentation status and coverage
doc-analyze	Analyze codebase, extract functions/classes/interfaces/types/API endpoints
doc-generate	Generate documentation (readme, api, diagram, changelog)

Core Modules

• src/core/code-analyzer.ts - TypeScript AST analysis using typescript package, extracts:
  • Functions with signatures, parameters, return types
  • Classes with properties, methods, constructors
  • Interfaces and type aliases
  • Enums with members
  • API endpoints (Express/Fastify routes)
  • JSDoc comments and tags