コードベースをインテリジェントに解析し、包括的なドキュメントを生成する、モデルコンテキストプロトコル(MCP)サーバー 正確なコード解析のために TypeScript と tree-sitter が組み込まれています。

##特徴

-マルチ言語サポート:TypeScript、JavaScript、およびPythonのコードベースを分析 -Smart Analysis: 抽出関数、クラス、メソッド、インターフェイス、タイプ、変数 -ドキュメントカバレッジ:ドキュメントカバレッジメトリックの計算

• ドキュメントの検出をissing:重症レベル(クリティカル、中低)で文書化されていないコードを識別する -AIパワード提案: ドキュメントテンプレートの生成と推奨の改善 -マークダウン出力: マークダウン形式のプロフェッショナルなドキュメント

インストール

使用法

##MCP サーバーとして

MCP クライアント設定 (Claude Desktop) に追加します。

Windows: %APPDATA%\Claude\claude_desktop_config.json

その後、Claudeデスクトップを再起動します。

利用可能なツール

##1. [[T1]

コードの要素を抽出し、文書のカバレッジを計算するためのコードベースまたはファイルを分析します。

入力:

出力:

• 分析されたファイルの合計
• 見つかった総コード要素
• ドキュメントのカバレッジの割合

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

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/