AI导哈

代码文档生成器

Smart-Docs-MCP是一款基于TypeScript的智能代码文档生成工具，支持多语言代码分析、自动文档生成、缺失文档检测及代码改进建议，旨在提升开发效率和代码质量。

  • by giinie
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 giinie/smart-docs-mcp

使用说明

Smart-Docs-MCP：智能代码文档生成器

**智能文档-MCP（或：智能文档管理平台）**这是一个用TypeScript构建的强大MCP（Model-Context-Protocol）服务器，旨在精确分析代码库并自动生成高质量文档。该工具通过自动化文档编制工作，帮助开发者提高生产力，并保持一致的代码质量。

主要功能

  • 多语言支持完美支持TypeScript、JavaScript和Python代码库。
  • 准确的代码分析： tree-sitter使用它来准确地解析和分析代码的结构。
  • 自动生成文档基于分析的代码，生成清晰且结构化的Markdown格式文档。
  • 检测未记录的代码找出缺失的文档部分，并根据严重程度（关键、中等、低）进行分类报告。
  • 代码改进建议提出具体改进方案，以提高代码的可读性、可维护性和文档质量。

MCP工具

此服务器提供以下四种核心MCP工具。

  1. analyze_codebase分析代码库的整体结构、文件、函数、类等，并提供摘要信息。
  2. generate_documentation以Markdown格式为特定代码片段（例如：函数或类）生成详细文档。
  3. detect_missing_docs在项目中识别出缺失的代码文档，并标出严重程度级别以辅助确定优先级。
  4. suggest_improvements为了养成更好的编码习惯，我提出以下关于代码风格、清晰度和文档编写方式的改进建议。

开始

要求

  • Node.js（版本18.x及以上）
  • npm（Node Package Manager，节点包管理器）

安装

  1. 克隆存储库。

    git clone https://github.com/your-username/smart-docs-mcp.git
cd smart-docs-mcp

  2. 安装所需的软件包。

    npm install

构建及运行

  1. 将TypeScript源代码编译为JavaScript。

    npm run build

  2. 启动MCP服务器。

    npm start

服务器成功启动后，可以通过MCP客户端发送请求。

项目结构

该项目采用模块化设计，以便于维护和扩展。

  • src/tools/这是各个MCP工具的核心逻辑实现的地方。
  • src/parsers/各种编程语言（tree-sitter （基础）的解析器。
  • src/generators/它包含根据分析的数据生成Markdown文档的逻辑。
  • src/core/负责MCP服务器的设置和协议处理。
  • src/utils/这里汇集了项目中广泛使用的实用函数。

贡献

如果您想为这个项目做出贡献，请随时提交拉取请求。请通过GitHub问题页面提交错误报告或功能建议。

相关 MCP