关键词

代码文档生成项目自动化AI辅助开发任务调度热重载

CodeLens是一个基于Model Context Protocol (MCP) 的智能文档协作平台，旨在为AI助手（如Claude Code）提供强大的后端支持，以实现从代码分析到高质量项目文档生成的全自动化流程。它通过标准化的协议，向LLM提供项目上下文信息、可调用的工具和预设的文档模板。

项目简介

CodeLens采用清晰的五层架构设计，集成了10个专业的MCP工具和16个覆盖不同文档层级的核心模板。它支持热重载功能，确保开发时的实时更新体验，并具备完善的任务管理和状态跟踪能力，为LLM驱动的文档生成提供了一个安全、高效且可扩展的框架。

主要功能点

  • 智能化项目分析： 自动识别项目类型、编程语言、使用的框架，并评估代码复杂度，为文档生成提供智能化的策略建议。
  • 任务驱动的文档生成： 将复杂的文档生成过程拆分为“项目分析”、“任务规划”、“任务执行”、“进度监控”、“文档验证”五个严谨阶段，并支持多种具体任务类型（如文件摘要、架构概述、README生成等）。
  • 丰富的MCP工具集： 提供10个即插即用的工具，涵盖工作流指导、项目结构扫描、任务计划生成、任务执行管理、任务状态查询、任务完成验证、AI辅助文档阅读、文件变化检测及增量更新建议等。
  • 四层文档模板体系： 包含16个预设模板，覆盖项目的“架构层”、“模块层”、“文件层”和“项目层”文档需求，确保生成文档的标准化和完整性。
  • 实时热重载： 在开发过程中，能够实时监控代码文件变化，自动重载相关模块和工具实例，无需重启服务器，极大提升开发效率和体验。
  • 状态感知与恢复： 持久化任务和会话状态，支持任务中断后的恢复，并提供实时的进度监控和系统健康检查。
  • 轻量级与易部署： 核心功能仅依赖Python标准库，部署过程简单快速。

安装步骤

  1. 环境要求： 确保您的系统已安装 Python 3.9 或更高版本。
  2. 克隆仓库： 将CodeLens项目从GitHub克隆到您的本地机器。 
    git clone https://github.com/MGX-LJY/CodeLens.git
cd CodeLens
  3. 无外部依赖： CodeLens的核心功能仅使用Python标准库，因此无需额外安装Python包（无需运行 'pip install'）。

服务器配置

MCP客户端（例如Claude Code）需要知道如何启动并连接CodeLens MCP服务器。您需要在MCP客户端的配置中添加以下JSON格式的服务器配置信息。请将 '/path/to/codelens' 替换为您的CodeLens项目实际所在的绝对路径。

{
  "mcpServers": {
    "codelens": {
      "command": "python",
      "args": ["mcp_server.py"],
      "cwd": "/path/to/codelens",
      "env": {
        "PYTHONPATH": "/path/to/codelens",
        "CODELENS_HOT_RELOAD": "true"
      },
      "description": "CodeLens智能文档协作平台MCP服务器，提供代码分析、文档生成和任务管理工具。",
      "features": [
        "ProjectAnalysis",
        "TaskManagement",
        "DocumentationGeneration",
        "HotReload",
        "AI_Assisted_Tools"
      ]
    }
  }
}
  • 'codelens': 您为该MCP服务器指定的名称，MCP客户端将通过此名称来识别和调用CodeLens服务器。
  • 'command': 启动服务器所用的可执行程序，这里是Python解释器。
  • 'args': 传递给Python解释器的参数，即CodeLens服务器的主程序文件 'mcp_server.py'。
  • 'cwd': 服务器的工作目录，必须设置为CodeLens项目的根目录，以便正确加载所有模块和资源。
  • 'env': 环境变量配置。
    • 'PYTHONPATH': 确保Python解释器能够找到CodeLens项目内部的 'src' 模块。
    • 'CODELENS_HOT_RELOAD': 控制热重载功能是否启用（'true'为启用，'false'为禁用）。
  • 'description' 和 'features': 提供给MCP客户端显示服务器功能和特点的描述，有助于用户理解和使用。

基本使用方法

  1. 启动CodeLens MCP服务器： 在CodeLens项目的根目录下，执行以下命令来启动服务器（默认开启热重载）：

    python mcp_server.py

    服务器启动后，它将等待MCP客户端的连接和请求。

  2. 通过MCP客户端调用工具： 一旦MCP客户端连接到CodeLens服务器，您就可以通过客户端的界面或API来调用CodeLens提供的各项工具。典型的文档生成流程如下：

    • 获取工作流指导： 调用 'init_tools' 工具，获取CodeLens 5阶段文档生成工作流的详细操作步骤和建议。
    • 智能项目分析： 调用 'doc_guide' 工具，让AI分析您的项目代码库，识别项目类型、框架、模块结构，并生成一份详细的项目分析报告和文档生成策略。
    • 生成任务计划： 根据 'doc_guide' 的分析结果，调用 'task_init' 工具生成一系列详细的文档生成任务，包括文件摘要、架构文档、项目README等，并构建任务依赖关系。
    • 任务执行（AI自动化）： MCP客户端将通过循环调用 'task_execute' 工具来驱动AI完成具体的文档生成任务。每次调用 'task_execute' 时，服务器会提供任务所需的模板、文件内容和执行上下文，AI根据这些信息生成文档内容，然后使用客户端的“Write”工具将文档保存到指定路径，并调用“task_complete”工具标记任务完成。
    • 实时状态监控： 在任务执行过程中，随时调用 'task_status' 工具来查询当前任务的进度、阶段完成度以及整体系统健康状况。
    • 文档验证确认： 当所有任务完成后，调用 'doc_verify' 工具来验证所有生成的文档的完整性和质量。

  3. AI辅助工具示例：

    • 智能文档阅读助手： 调用 'project_overview' 工具，扫描项目已有的文档文件夹，生成AI阅读提示词，帮助AI快速理解项目现有文档。
    • 增量更新检测： 首先调用 'doc_update_init' 初始化文件指纹基点，随后调用 'doc_update' 工具来检测项目代码文件的变化，并生成文档更新建议。

信息

分类

开发者工具

访问项目