AI导哈

GitLab文档生成器

Alreadme是一个自动化的GitLab文档生成器，利用AI模型分析代码库并自动生成README.md文件。

  • by rojinebrahimi
  • Python
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 rojinebrahimi/alreadme

使用说明

Alreadme

Alreadme是一个使用模型上下文协议（MCP）和Google Gemini（或其他客户端）构建的自动化GitLab文档生成器。

它充当AI模型和GitLab存储库之间的桥梁。AI扫描你的代码库，分析逻辑，并自动将一个全面的README.md文件提交给你的项目。

特性

  • 智能发现：递归列出项目文件，同时忽略构建工件和依赖关系。
  • 文件筛选：自动关注高价值的代码文件（Python、Go、Helm、Bash、Dockerfile）以减少噪音。
  • 自动提交：通过API直接在GitLab存储库中创建或更新README.md文件。
  • 符合MCP标准：实现标准的模型上下文协议，使服务器与其他MCP客户端兼容。

需求

  • Python 3.10+
  • GitLab个人访问令牌
  • Google Gemini API密钥

安装

  1. 克隆存储库：

    git clone [https://github.com/YOUR_USERNAME/alreadme.git](https://github.com/YOUR_USERNAME/alreadme.git)
cd alreadme

  2. 安装依赖项（建议使用uv）：

    uv sync

    或者使用pip：

    pip install -r requirements.txt

配置

创建一个 .env 根目录中包含您的凭据的文件：

GITLAB_URL=[https://gitlab.com](https://gitlab.com)
GITLAB_ACCESS_TOKEN=your_private_gitlab_token
GITLAB_PROJECT_ID=your_target_project_id
GOOGLE_API_KEY=your_gemini_api_key
GOOGLE_AI_MODEL=your_gemini_model_name

用法

运行客户端脚本以启动生成过程：

uv run client.py

脚本将：

  1. 连接到配置中定义的GitLab项目。
  2. 分析文件结构并读取源代码。
  3. 生成结构化的README。
  4. 将新文件提交到存储库的默认分支。

建筑

  • 服务器.py：与GitLab API交互的MCP服务器。它公开了用于列出文件、读取内容和保存更改的工具。
  • 客户端.py：连接到Google Gemini的客户端应用程序。它初始化服务器并指示AI记录项目。

相关 MCP