README
🚀 Git 提交助手 MCP 服务器
Git 提交助手 MCP 服务器借助 AI 自动完成 Git 提交操作,让您轻松追踪代码库中 AI 的贡献。它基于 TypeScript 构建,能在提交已阶段化的更改时,自动在提交者名称后添加 "(aider)",为代码管理带来便利。
🚀 快速开始
此 MCP 服务器仅提供一个工具:commit_staged,用于使用特定消息提交已阶段化的更改。使用时,您只需将服务器配置添加到 MCP 设置文件中,即可让 AI 代您执行提交操作。提交者信息会从环境变量或 git config 命令输出中获取。带有 "(aider)" 的提交可被 aider --stats 命令检测到,从而显示代码库中 AI 的贡献。
✨ 主要特性
- AI 辅助提交:让 AI 代您执行 Git 提交,追踪代码库中的 AI 贡献。
- 自动添加标识:在提交者名称后自动添加 "(aider)",便于区分 AI 提交。
- 灵活配置:可通过环境变量或
git config命令获取提交者信息。
📦 安装指南
要使用此服务器,请将其配置添加到您的 MCP 设置文件中:
{
"mcpServers": {
"git-commit-aider": {
"command": "npx",
"args": ["mcp-git-commit-aider"]
}
}
}
提交者信息从以下位置获取:
- 环境变量
GIT_COMMITTER_NAME和GIT_COMMITTER_EMAIL,遵循 Git 的约定。 git config user.name和git config user.email命令的输出。
💻 使用示例
基础用法
将此工具安装在您的代码编辑器中后,您可以 prompting AI 如下:
为我提交这些更改
通常,在 AI 对您的代码库进行一些更改之后会发生这种情况,因此很多时候 AI 能够根据上下文提供一个不错的提交消息。
📚 详细文档
开发
安装依赖项
npm install
构建服务器
npm run build
带有自动重建的开发
npm run watch
示例 MCP 配置
{
"mcpServers": {
"git-commit-aider": {
"command": "node",
"args": [
"/path/to/git-commit-aider/build/index.js"
]
}
}
}
(将 /path/to/git-commit-aider 替换为您实际的服务器目录路径。)
调试
由于 MCP 服务器通过标准输入输出进行通信,调试可能具有挑战性。我们建议使用 MCP Inspector,它是可作为包脚本运行的工具:
npm run inspector
Inspector 将提供一个访问调试工具的 URL,在您的浏览器中打开即可。
微信扫一扫