自动文档生成工具

自动文档生成工具

通过分析代码库目录结构和文件,自动生成文档的MCP服务器。

快速入门

安装

  1. 克隆仓库:git clone https://github.com/PARS-DOE/autodocument.git
  2. 进入目录:cd autodocument
  3. 安装依赖:npm install
  4. 构建项目:npm run build

配置

设置环境变量:

  • OPENROUTER_API_KEY: OpenRouter API 密钥
  • 可选配置:OPENROUTER_MODEL, MAX_FILE_SIZE_KB, MAX_FILES_PER_DIR

使用

运行命令生成文档:node build/index.js /path/to/your/project

支持的功能包括:

  • 自动生成文档(documentation.md)
  • 测试计划(testplan.md)
  • 代码审查(review.md)

更多详细信息请参考 README。