基本能力
产品定位
mcp-server-auto-commit 是一个开发辅助工具,旨在提高代码提交的效率和规范性,特别适合团队协作开发场景。
核心功能
- 分析 Git 仓库中的变更(包括已暂存和未暂存的文件)
- 使用 GPT-4o-mini 模型生成符合规范的提交信息
- 提供详细的变更摘要,包括:
- 📝 修改的文件
- ✨ 新增的文件
- 🗑️ 删除的文件
- 📄 每个文件的详细变更(最多显示10行)
- 自动添加提交签名
- 基于 @modelcontextprotocol/sdk 构建
适用场景
- 团队协作开发,需要规范提交信息的项目
- 频繁提交代码,希望自动化提交过程的开发者
- 需要详细记录代码变更历史的项目
工具列表
git-changes-commit-message
- 功能:分析当前 Git 仓库的变更,使用 GPT-4o-mini 模型生成提交信息
- 提供:
- 带有状态指示器的修改文件列表
- 新增文件列表
- 删除文件列表
- 每个文件的详细变更(限制为10行以提高可读性)
- 符合常规提交格式的提交信息
- 自动提交签名
- 使用参数:
autoCommitPath
:可选,用于分析特定目录/文件的路径。如未提供,则使用当前工作目录
常见问题解答
- 如何设置 OpenAI API 密钥?
- 设置为环境变量:
OPENAI_API_KEY=your-api-key
- 作为命令行参数传递:
--key your-api-key
-
添加到项目根目录的
.env
文件中 -
如何与 Cursor 集成?
- 转到 Cursor 设置 -> MCP -> 添加新的 MCP 服务器
-
配置 MCP:
- 名称:git-auto-commit
- 类型:command
- 命令:
node ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js --key your-api-key
-
如何与 Claude Desktop 集成?
- 将以下 MCP 配置添加到 Claude Desktop 配置中:
json
{
"mcpServers": {
"git-auto-commit": {
"command": "node",
"args": ["ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js", "--key", "your-api-key"]
}
}
}
使用教程
使用依赖
- Node.js
- OpenAI API key
- Git 仓库
- pnpm 包管理器
安装教程
-
克隆仓库:
bash
git clone https://github.com/jatinsandilya/mcp-server-auto-commit.git
cd mcp-server-auto-commit -
安装依赖:
bash
pnpm install -
设置 OpenAI API 密钥(见常见问题解答)
-
构建项目:
bash
pnpm run build
调试方式
-
修改服务器配置(
index.ts
):
typescript
const server = new McpServer({
name: "git-auto-commit",
version: "0.0.1",
}); -
构建并测试变更:
bash
pnpm run build