关键词

Git工作流AI助手MCPLLM代码审查变更日志发布说明

使用说明

项目简介

Git-Iris MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在为 Claude、Cursor、VSCode 等 MCP 客户端提供强大的 Git 工作流辅助功能。它通过 JSON-RPC 协议与客户端通信，提供资源管理、工具注册执行和 Prompt 模板渲染等核心 MCP 服务器功能，助力开发者提升 Git 工作流程的效率和质量。

主要功能点

  • 智能提交信息生成: 通过 AI 自动生成符合规范且信息丰富的 Git 提交消息。
  • AI 代码审查: 利用 AI 技术对代码变更进行多维度审查，提供改进建议。
  • 动态变更日志生成: 根据 Git 历史记录，自动生成结构化的变更日志。
  • 综合发布说明: 基于变更日志，生成详细且易于理解的发布说明文档。
  • 多 LLM 提供商支持: 支持 OpenAI, Anthropic, Google, Ollama 等多种 LLM 模型，灵活选择。
  • 远程仓库支持: 无需手动克隆，直接处理远程 Git 仓库。
  • 用户友好的 CLI: 提供交互式命令行界面，方便用户操作和配置。
  • Docker 支持: 易于部署和集成到 CI/CD 流程中。
  • MCP 协议支持: 通过 Model Context Protocol 与各种 AI 工具无缝集成。

安装步骤

  1. 环境准备: 确保已安装 Rust 和 Cargo (最新稳定版) 以及 Git 2.23.0 或更高版本。

  2. 通过 Cargo 安装 (推荐):

    cargo install git-iris

  3. 通过 Docker 安装:

    docker pull hyperb1iss/git-iris:latest

    运行 Docker 镜像:

    docker run --rm -v "$(pwd):/git-repo" hyperb1iss/git-iris gen

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接 Git-Iris MCP 服务器：

{
  "serverName": "GitIris",  // MCP 服务器名称，可自定义
  "command": "git-iris",    // 启动 MCP 服务器的命令
  "args": ["serve"]         // 启动命令的参数，这里使用 "serve" 启动 MCP 服务器
}

参数说明:

  • 'serverName': 自定义的服务器名称，用于在 MCP 客户端中标识 Git-Iris 服务器。
  • 'command': 启动 Git-Iris MCP 服务器的可执行文件命令，通常为 'git-iris'（如果已添加到系统 PATH）。
  • 'args': 传递给 'git-iris serve' 命令的参数，使用 '["serve"]' 即可启动基于 stdio 传输的 MCP 服务器。

更多配置选项:

  • SSE 传输: 如果 MCP 客户端需要 SSE 传输，可以将 'args' 修改为 '["serve", "--transport", "sse", "--port", "3077"]'，并确保客户端配置连接到 'ws://127.0.0.1:3077'。
  • 开发模式: 如需启用开发模式以获得更详细的日志输出，可以将 'args' 修改为 '["serve", "--dev"]'。

基本使用方法

  1. 启动 MCP 服务器: 在命令行中运行 'git-iris serve' 命令即可启动 MCP 服务器。默认使用 stdio 传输协议。

  2. 配置 MCP 客户端: 在支持 MCP 协议的 AI 工具（如 Claude, Cursor, VSCode 等）中，配置连接到 Git-Iris MCP 服务器，并使用上面提供的 JSON 配置信息。

  3. 在 AI 工具中使用 Git-Iris 功能: 配置完成后，即可在 AI 工具中调用 Git-Iris 提供的功能，例如：

    • 在代码编辑器中使用 AI 生成提交信息
    • 在 AI 助手中使用 Git-Iris 进行代码审查
    • 在 AI 工具中调用 Git-Iris 生成变更日志或发布说明

具体使用方式请参考对应 MCP 客户端的文档，通常会在工具的设置或扩展配置中找到 MCP 服务器的配置选项。

信息

分类

开发者工具

访问项目