🚀 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 服务器脚本。
✨ 主要特性
- 更改分析：能够分析 Git 存储库中的更改，涵盖已暂存和未暂存的更改。
- 智能生成：使用 GPT - 4o - mini 模型生成符合常规规范的提交信息。
- 详细总结：
- 📝 列出修改的文件。
- ✨ 展示新增的文件。
- 🗑️ 显示删除的文件。
- 📄 呈现每个文件的详细更改（每个文件最多显示 10 行）。
- 技术构建：基于 @modelcontextprotocol/sdk 构建。
- 自动签名：每次提交都会自动添加签名。
📦 安装指南
先决条件
- 已安装 Node.js
- 拥有 OpenAI API 密钥
- 具备要分析的 Git 存储库
- 安装了 pnpm 包管理器
💻 使用示例
使用 Cursor
- 打开设置 -> MCP -> 添加新的 MCP 服务器。
- 配置您的 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"]
}
}
}
命令行使用示例
在终端中运行：
node build/index.js
这将启动 MCP 服务器，并监听来自集成工具的请求。
📚 详细文档
可用工具
git - changes - commit - message
此工具可分析当前 Git 存储库中的更改，并使用 OpenAI 的 GPT - 4o - mini 模型生成提交信息。它会提供：
- 修改文件的列表及其状态指示器。
- 新增文件的列表。
- 删除文件的列表。
- 每个文件的详细更改（每个文件最多显示 10 行）。
- 符合常规提交格式的生成提交信息。
- 自动提交签名。
使用参数：
autoCommitPath：可选路径，用于指定要分析的具体路径。
项目结构
mcp-server-auto-commit/
├── index.ts # 主服务器实现文件，包含Git分析工具
├── package.json # 项目依赖管理
├── tsconfig.json # TypeScript 配置文件
└── build/ # 编译输出 JavaScript 文件
🔧 技术细节
本项目使用 Node.js 作为运行环境，借助 OpenAI 的 GPT - 4o - mini 模型生成提交信息。使用 @modelcontextprotocol/sdk 构建服务器，通过分析 Git 存储库中的更改，生成详细的提交信息总结。
📄 许可证
[此处填写许可证信息]
👋 注意事项
- 请确保安装了最新版本的 Node.js 和 pnpm。
- 验证 OpenAI API 密钥是否有效。
- 检查防火墙设置，确保服务器可以访问互联网。
🤝 贡献指南
欢迎大家贡献代码！请 fork 此仓库并提交拉取请求。
📞 联系方式
如需联系，请发送邮件至 [your.email@example.com] 或访问项目主页。