
njengah/smart-docs-mcp
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
MCP-сервер, который анализирует кодовые базы и генерирует документацию для вас
Обзор
Сервер Model Context Protocol (MCP), который интеллектуально анализирует кодовые базы и генерирует полную документацию. Создан с помощью TypeScript и tree-sitter для точного анализа кода. Анализ кодовых баз TypeScript, JavaScript и Python: Извлечение функций, классов, методов, интерфейсов, типов и переменных: Вычисление показателей охвата документации: Идентификация недокументированного кода с уровнями серьезности (критический, средний, низкий) - Создание шаблонов документации и рекомендации по улучшению - Профессиональная документация в формате разметки Добавьте конфигурацию клиента MCP (Claude Desktop): %APPDATA%\Claude\claude desktop config.json Анализ кодовой базы или файла для извлечения элементов кода и расчета покрытия документации. - Общий анализ файлов - Общие найденные элементы кода - Процент покрытия документации - Подробная разбивка по файлам и элементам Создайте полную документацию для кодовой базы.
Обзор (машинный перевод)
Сервер Model Context Protocol (MCP), который интеллектуально анализирует кодовые базы и генерирует полную документацию. Создан с помощью TypeScript и tree-sitter для точного анализа кода.
Особенности
** Поддержка нескольких языков**: анализ кодовых баз TypeScript, JavaScript и Python Умный анализ: извлечение функций, классов, методов, интерфейсов, типов и переменных Документация: Расчет показателей охвата документации ** Недостающее обнаружение врача **: идентификация незарегистрированного кода с уровнями серьезности (критический, средний, низкий)
- ** Предложения, основанные на ИИ**: Создание шаблонов документации и рекомендаций по совершенствованию
- Markdown Output Профессиональная документация в формате разметки
##Установка
Использование
###Как MCP-сервер
Добавьте конфигурацию клиента MCP (Claude Desktop):
**Windows: ** %APPDATA%\Claude\claude_desktop_config.json
Тогда перезапустите Клода Десктопа.
Доступные инструменты
###1.[[Т1]]
Анализ кодовой базы или файла для извлечения элементов кода и расчета покрытия документации.
** Ввод:**
** Результат:** Общий анализ файлов Найдены общие элементы кода
- Процент покрытия документации
Эта страница переведена автоматически. Технические детали смотрите в оригинале.
README
Показан фрагмент оригинального README. Открыть оригинал.
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/
Установка
This server does not publish a one-line install command.
Open the repository installation guide Новичок в MCP? Начните с руководства на mcpskill.org →Конфигурация
{
"mcpServers": {
"smart-docs": {
"command": "node",
"args": ["C:\\ProjectFolder\\dist\\index.js"]
}
}
}