仓库文档生成器

一个基于Django和AI的GitHub仓库文档生成工具,可分析仓库结构、问题和拉取请求,并生成Markdown和HTML格式的文档。

  • by mrvivekkr
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 mrvivekkr/github-mcp-ai-repo-analyzer

使用说明

GitHub MCP AI回购分析器

这个项目是一个基于Django的仓库文档生成器,由代理AI提供支持,集成了GitHub MCP服务器工具包。它总结了任何GitHub存储库的结构、开放问题、拉取请求和分支,生成清晰的Markdown和HTML输出。


概述

分析公共或私有GitHub存储库,并使用AI和MCP CLI工具生成简洁的文档。代理工作流使用OpenAI获取和汇总数据,并在浏览器中显示结果。


示例输出

请参阅为GitHub MCP Server仓库生成的示例文档:

上面的示例文件说明了此工具如何可视化存储库结构、未解决的问题、拉取请求等。


快速启动

  1. 构建MCP服务器和CLI工具
git clone https://github.com/github/github-mcp-server.git
cd github-mcp-server
go build -o github-mcp-server ./cmd/github-mcp-server
go build -o mcpcurl ./cmd/mcpcurl

将这两个二进制文件复制到Django项目根目录中:

cp github-mcp-server mcpcurl /path/to/your/project/
  1. 设置环境变量
  • 创建一个 .env 项目根目录中的文件:
    OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    GITHUB_PERSONAL_ACCESS_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    
  1. 安装Python依赖项
pip install -r requirements.txt
  1. 运行服务器
python manage.py runserver 127.0.0.1:8000
  1. 访问 http://127.0.0.1:8000 在您的浏览器中。

特性

  • 带有可点击树的存储库结构摘要。
  • 发布和拉取请求获取和摘要。
  • 分行列表。
  • 人工智能驱动的Markdown和HTML文档。

故障排除

  • 对于空结果或“401错误凭据”,请检查您的GitHub令牌:
  • 必须正确,未过期,并且 repo 和 user 范围。
  • 对于二进制错误,请重新生成 mcpcurl 和 github-mcp-server 对于您的操作系统。
  • 确保你的 .env 值与shell中加载的值匹配。

参考文献