Skip to main content
Glama
Smart Docs MCP Server
by Njengah

Smart Docs MCP Server

A production-ready Model Context Protocol (MCP) server that intelligently analyzes codebases and generates comprehensive documentation. Built with TypeScript and tree-sitter for accurate code parsing.

Features

  • Multi-Language Support: Analyze TypeScript, JavaScript, and Python codebases

  • Smart Analysis: Extract functions, classes, methods, interfaces, types, and variables

  • Documentation Coverage: Calculate documentation coverage metrics

  • Missing Doc Detection: Identify undocumented code with severity levels (critical, medium, low)

  • AI-Powered Suggestions: Generate documentation templates and improvement recommendations

  • Markdown Output: Professional documentation in markdown format

Related MCP server: Documentation MCP Server

Installation

npm install
npm run build

Usage

As an MCP Server

Add to your MCP client configuration (Claude Desktop):

Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "smart-docs": {
      "command": "node",
      "args": ["C:\\ProjectFolder\\dist\\index.js"]
    }
  }
}

Then restart Claude Desktop.

Available Tools

1. analyze_codebase

Analyze a codebase or file to extract code elements and calculate documentation coverage.

Input:

{
  "path": "/path/to/your/codebase"
}

Output:

  • Total files analyzed

  • Total code elements found

  • Documentation coverage percentage

  • Detailed breakdown by file and element

2. generate_documentation

Generate comprehensive markdown documentation for a codebase.

Input:

{
  "path": "/path/to/your/codebase",
  "format": "markdown"
}

Output:

  • Complete markdown documentation

  • Summary statistics

  • Organized by file and element type

3. detect_missing_docs

Detect code elements missing documentation with severity classification.

Input:

{
  "path": "/path/to/your/codebase",
  "minSeverity": "critical"
}

Severity Levels:

  • Critical: Public classes, interfaces, and exported functions

  • Medium: Type aliases and exported types

  • Low: Private methods and internal variables

Output:

  • List of missing documentation by severity

  • Summary statistics by severity and type

  • Detailed element information

4. suggest_improvements

Analyze existing documentation and suggest improvements.

Input:

{
  "path": "/path/to/your/codebase",
  "limit": 20
}

Output:

  • Documentation templates for missing docs

  • Suggestions for incomplete documentation

  • Parameter and return value documentation hints

Project Structure

smart-docs-mcp/
├── src/
│   ├── index.ts                    # MCP server entry point
│   ├── types/
│   │   └── index.ts               # TypeScript types and interfaces
│   ├── parsers/
│   │   ├── base-parser.ts         # Abstract parser base class
│   │   ├── typescript-parser.ts   # TypeScript/JavaScript parser
│   │   └── python-parser.ts       # Python parser
│   ├── analyzers/
│   │   ├── codebase-analyzer.ts   # Main analysis engine
│   │   └── doc-detector.ts        # Missing documentation detector
│   ├── generators/
│   │   ├── markdown-generator.ts  # Markdown doc generator
│   │   └── improvement-suggester.ts # Improvement suggestions
│   ├── tools/
│   │   ├── analyze-codebase.ts
│   │   ├── generate-documentation.ts
│   │   ├── detect-missing-docs.ts
│   │   └── suggest-improvements.ts
│   └── utils/
│       └── file-utils.ts          # File system utilities
├── package.json
├── tsconfig.json
└── README.md

How It Works

  1. Parsing: Uses tree-sitter to parse source code into Abstract Syntax Trees (AST)

  2. Extraction: Identifies code elements (functions, classes, etc.) from the AST

  3. Documentation Detection: Checks for JSDoc, docstrings, and inline comments

  4. Analysis: Calculates coverage and detects missing documentation

  5. Generation: Creates markdown documentation and improvement suggestions

Severity Classification

The server uses intelligent severity classification:

  • Public APIs (classes, interfaces, exported functions) → Critical

  • Type definitions and complex types → Medium

  • Private methods and internal variables → Low

Error Handling

All tools include comprehensive error handling:

  • Invalid paths return descriptive error messages

  • Unsupported file types are gracefully skipped

  • Parse errors include file location and context

Development

# Install dependencies
npm install

# Build the project
npm run build

# Watch mode for development
npm run watch

# Run the server
npm start

Requirements

  • Node.js >= 18.0.0

  • TypeScript 5.3+

Dependencies

  • @modelcontextprotocol/sdk: MCP protocol implementation

  • tree-sitter: Code parsing engine

  • tree-sitter-typescript: TypeScript/JavaScript grammar

  • tree-sitter-python: Python grammar

  • zod: Schema validation

Testing

A test project is included in the test-project/ directory with sample files demonstrating various documentation scenarios.

License

MIT

Contributing

Contributions are welcome! Please ensure:

  • Code follows TypeScript best practices

  • All new features include error handling

  • Documentation is updated according

Available Tools

4 tools
analyze_codebaseC

Analyze a codebase or file to extract code elements and calculate documentation coverage. Supports TypeScript, JavaScript, and Python.

Inputs: path.

detect_missing_docsC

Detect code elements that are missing documentation and categorize them by severity (critical, medium, low).

Inputs: path, minSeverity.

generate_documentationC

Generate comprehensive markdown documentation for a codebase or file, including all code elements and their existing documentation.

Inputs: path, format.

suggest_improvementsC

Analyze existing documentation and suggest improvements, including templates for missing docs and enhancements for incomplete documentation.

Inputs: path, limit.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.5/5.0

    Scored across 4 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose with no ambiguity: analyze_codebase extracts and assesses coverage, detect_missing_docs identifies gaps, generate_documentation creates full documentation, and suggest_improvements enhances existing docs. The descriptions clearly differentiate their roles in the documentation workflow.

    Naming Consistency5/5

    All tool names follow a consistent verb_noun pattern (analyze_codebase, detect_missing_docs, generate_documentation, suggest_improvements) using snake_case throughout. This predictable naming makes it easy for agents to understand and select tools.

    Tool Count5/5

    With 4 tools, the set is well-scoped for a documentation-focused server, covering analysis, detection, generation, and improvement phases. Each tool earns its place without redundancy, aligning perfectly with the server's purpose.

    Completeness5/5

    The tool surface provides complete lifecycle coverage for documentation tasks: analyze for assessment, detect for gap identification, generate for creation, and suggest for refinement. There are no obvious gaps, enabling agents to handle documentation workflows end-to-end.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers