MCP Server to Auto commit changes 🛠️

MCP 服务自动提交更改 🛠️

此实现提供了一个 Git 更改分析器，可使用 OpenAI 的 GPT 模型生成提交消息。

演示

功能

• 分析代码库中的 Git 更改（包括已暂存和未暂存的更改）
• 使用 GPT-4o-mini 生成符合约定式提交规范的提交消息
• 提供详细摘要，包括：
  • 📝 已修改文件
  • ✨ 新增文件
  • 🗑️ 已删除文件
  • 📄 详细更改（每个文件最多 10 行）
• 基于 @modelcontextprotocol/sdk 构建
• 为每次提交添加自动提交签名

项目结构

mcp-server-auto-commit/
├── index.ts        # Main server implementation with git analysis tool
├── package.json    # Project dependencies
├── tsconfig.json   # TypeScript configuration
└── build/         # Compiled JavaScript output

前提条件

• 已安装 Node.js
• OpenAI API 密钥
• 用于分析的 Git 代码库
• pnpm 包管理器

开始使用

1. 克隆此代码库：

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

2. 安装依赖项：

pnpm install

3. 使用以下任一方法设置 OpenAI API 密钥：

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

4. 构建项目：

pnpm run build

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

与 Cursor 配合使用

1. 前往 Cursor Settings -> MCP -> Add new MCP server
2. 配置 MCP：
   • 名称：git-auto-commit
   • 类型：command
   • 命令：node ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js --key your-api-key （如果未在环境中设置，请将 your-api-key 替换为实际的 OpenAI API 密钥）

与 Claude Desktop 配合使用

将以下 MCP 配置添加到 Claude Desktop 配置中：

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

可用工具

git-changes-commit-message

此工具会分析代码库中当前的 Git 更改，并使用 OpenAI 的 GPT-4o-mini 模型生成提交消息。它会提供：

• 已修改文件列表及状态指示
• 新增文件列表
• 已删除文件列表
• 每个文件的详细更改（为便于阅读，每个文件最多显示 10 行）
• 遵循约定式提交格式生成的提交消息
• 自动提交签名

使用参数：

• autoCommitPath：可选，用于分析特定目录或文件的路径。若未提供，则使用当前工作目录。

开发

index.ts 中的实现展示了：

1. 使用适当的配置设置 MCP 服务
2. 处理命令行参数和环境变量
3. 使用 GPT-4o-mini 模型接入 OpenAI API
4. 使用子进程执行 Git 操作
5. 错误处理和回退机制
6. 详细的更改分析和格式化

要修改或扩展此实现：

1. 在 index.ts 中更新服务配置：

const server = new McpServer({
  name: "git-auto-commit",
  version: "0.0.1",
});

2. 工具通过 server.tool() 定义，并使用 Zod 架构进行适当的参数验证。

3. 构建并测试更改：

pnpm run build

贡献

欢迎提交问题和改进建议！

许可证

MIT