AI文档生成工具

AutoDoc.AI是一款基于OpenAI GPT-3.5-turbo的AI增强文档生成工具,支持多种编程语言和框架,可生成架构文档、图表、API规范等。

  • by AISIRIJ
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 aisirij/autodoc-ai-mcp-server

使用说明

自动文档。AI-MCP服务器

使用OpenAI GPT-3.5-turbo的AI增强文档生成器。

特性

  • AI驱动的文档:使用OpenAI生成智能、专业的文档
  • 多语言支持:Java、TypeScript、Python、C#
  • 框架检测:Spring Boot、Express、Django。网
  • 综合产出:架构文档、图表、API规范、合规性报告
  • MCP集成:与Claude Desktop无缝协作

安装

  1. 克隆存储库
  2. 安装依赖项: npm install
  3. 构建: npm run build
  4. 在Claude Desktop中配置MCP设置
  5. { “mcpServers”:{ “autodoc ai”:{ “command”:“node”, “args”:[“{project_path}/dist/index.js”] } } }

用法

可用的两个主要工具:

  • generate_ai_documentation:使用特定语言/框架生成文档
  • detect_and_document:自动检测项目类型并生成文档

需求

  • Node.js 18+
  • OpenAI API密钥
  • 支持MCP的Claude桌面

生成的文档

  • 带有AI描述的主要文档

  • 架构文档

  • PlantUML序列图

  • 实体关系图

  • OpenAPI规范

    使用示例

    “使用OpenAI API密钥sk-…为位于/path/to/my/project的Java Spring Boot项目生成文档,并输出到/path/to/docs”