Git Auto Commit

🚀 Git 自动提交服务器 🛠️

本项目提供了一个 Git 更改分析器，借助 OpenAI 的 GPT 模型来自动生成提交信息，极大提升了 Git 提交的效率与准确性。

🚀 快速开始

克隆仓库

git clone https://github.com/jatinsandilya/mcp-server-auto-commit.git
cd mcp-server-auto-commit

安装依赖项

pnpm install

设置 OpenAI API 密钥

您可以通过以下任意一种方式设置 OpenAI API 密钥：

• 作为环境变量：OPENAI_API_KEY=your-api-key
• 通过命令行参数传递：--key your-api-key
• 添加到项目根目录的 .env 文件中

构建项目

pnpm run build

此命令将生成 /build/index.js 文件，即编译后的 MCP 服务器脚本。

使用 Cursor

1. 打开设置 -> MCP -> 添加新的 MCP 服务器
2. 配置您的 MCP：
   • 名称：git-auto-commit
   • 类型：命令
   • 命令：node ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js --key your-api-key （请将 your-api-key 替换为实际的 OpenAI API 密钥，若未在环境变量中设置）

使用 Claude Desktop

在您的 Claude Desktop 配置中添加以下 MCP 配置：

{
  "mcpServers": {
    "git-auto-commit": {
      "command": "node",
      "args": ["ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js", "--key", "your-api-key"]
    }
  }
}

✨ 主要特性

• 智能更改分析：可分析 Git 存储库中的更改，涵盖已暂存和未暂存的更改。
• 智能提交信息生成：利用 GPT - 4o - mini 模型生成常规提交信息。
• 详细总结：
  • 📝 清晰列出修改的文件。
  • ✨ 明确展示新增的文件。
  • 🗑️ 准确呈现删除的文件。
  • 📄 展示文件的详细更改（每个文件最多显示 10 行）。
• 强大构建工具：使用 @modelcontextprotocol/sdk 构建。
• 自动签名：每次提交都会添加自动签名。

📦 安装指南

先决条件

• 已安装 Node.js
• 拥有 OpenAI API 密钥
• 具备要分析的 Git 存储库
• 安装了 pnpm 包管理器

安装步骤

1. 克隆仓库：git clone https://github.com/jatinsandilya/mcp-server-auto-commit.git
2. 进入项目目录：cd mcp-server-auto-commit
3. 安装依赖：pnpm install
4. 设置 API 密钥
5. 构建项目：pnpm run build

💻 使用示例

基础用法

在终端中运行以下命令启动 MCP 服务器，并监听来自集成工具的请求：

node build/index.js

📚 详细文档

项目结构

mcp-server-auto-commit/
├── index.ts        # 主服务器实现文件，包含Git分析工具
├── package.json    # 项目依赖管理
├── tsconfig.json   # TypeScript 配置文件
└── build/         # 编译输出 JavaScript 文件

可用工具

git - changes - commit - message

此工具用于分析当前 Git 存储库中的更改，并使用 OpenAI 的 GPT - 4o - mini 模型生成提交信息。它会提供以下内容：

• 修改文件的列表及其状态指示器
• 新增文件的列表
• 删除文件的列表
• 每个文件的详细更改（每个文件最多显示 10 行）
• 符合常规提交格式的生成提交信息
• 自动提交签名

使用参数：

• autoCommitPath：可选路径，用于指定要分析的具体路径

如何使用

安装依赖

pnpm install

构建项目

pnpm run build

运行服务器

构建完成后，运行生成的可执行文件（根据平台有所不同）。

🔧 技术细节

本项目使用 Node.js 作为运行环境，借助 TypeScript 进行开发。主服务器实现文件 index.ts 包含了 Git 分析工具，项目依赖通过 package.json 进行管理，TypeScript 配置则由 tsconfig.json 完成。编译后的 JavaScript 文件会输出到 build/ 目录。同时，项目使用 @modelcontextprotocol/sdk 构建，利用 GPT - 4o - mini 模型生成提交信息。

📄 许可证

[此处填写许可证信息]

联系方式

如需联系，请发送邮件至 [your.email@example.com] 或访问项目主页。

演示

⚠️ 重要提示

• 请确保安装了最新版本的 Node.js 和 pnpm。
• 务必验证 OpenAI API 密钥是否有效。
• 检查防火墙设置，确保服务器可以访问互联网。

💡 使用建议

建议在使用前仔细检查 OpenAI API 密钥的设置，避免因密钥无效导致无法正常生成提交信息。同时，定期更新项目依赖，以保证项目的稳定性和安全性。

贡献指南

欢迎贡献！请 fork 此仓库并提交拉取请求。