README
🚀 GitStandup MCP 服务器
GitStandup MCP 服务器借助人工智能,依据你的 Git 提交记录生成每日站会笔记。它是一个 模型上下文协议 (MCP) 服务器,能自动从多个仓库收集你的 Git 提交记录,助力 AI 助手生成自然、全面的站会总结。
✨ 主要特性
- 📦 多仓库支持:可跟踪所有项目中的提交记录。
- 👤 用户特定:仅显示你本人的提交记录(通过 Git 用户邮箱过滤)。
- ⏰ 基于时间:可配置回顾周期(默认:过去 24 小时)。
- 🎯 智能差异分析:包含代码变更,并进行智能截断处理。
- 💾 持久化配置:将你的仓库信息存储在
~/.gitstandup/config.json中。 - 🧹 输出简洁:跳过生成文件(如锁文件、压缩代码)。
🚀 快速开始
安装
# 使用 npx(无需安装)
npx -y gitstandup-mcp
# 或者全局安装
npm install -g gitstandup-mcp
与 Claude Desktop 进行配置
在 ~/Library/Application Support/Claude/claude_desktop_config.json 中添加以下内容:
{
"mcpServers": {
"gitstandup": {
"command": "npx",
"args": ["-y", "gitstandup-mcp"]
}
}
}
与 VS Code(GitHub Copilot)进行配置
在 VS Code 的 MCP 设置中添加以下内容:
{
"gitstandup": {
"type": "stdio",
"command": "npx",
"args": ["-y", "gitstandup-mcp"]
}
}
📖 使用方法
配置完成后,你可以使用自然语言与 AI 助手交互:
"生成我的站会笔记"
"我昨天做了什么?"
"显示我过去两天的提交记录"
首次设置
- 添加你的仓库:
"将 /path/to/my/project 添加到 GitStandup"
- 生成站会笔记:
"生成我的站会笔记"
- AI 会生成如下总结:
昨天我:
- 在 api-server 中实现了 OAuth 认证流程
- 修复了支付处理中的严重 bug
- 为用户注册添加了集成测试
🛠️ 可用工具
该服务器提供了四个 MCP 工具,供 AI 助手使用:
generate_standup
根据配置的仓库生成站会笔记。 参数:
hours(可选):回顾的小时数(默认:24)repos(可选):要使用的特定仓库路径数组
示例:
{
"hours": 48, // 过去两天
"repos": ["/path/to/repo1", "/path/to/repo2"] // 可选
}
add_repos
将仓库路径添加到配置中。 参数:
paths:Git 仓库的绝对路径数组
示例:
{
"paths": ["/Users/you/projects/my-app", "/Users/you/projects/api"]
}
list_repos
列出当前配置的仓库。 返回值:配置的仓库路径数组
remove_repos
从配置中移除仓库路径。 参数:
paths:要移除的仓库路径数组
🔧 开发
# 克隆仓库
git clone https://github.com/muba00/gitstandup.git
cd gitstandup
# 安装依赖
npm install
# 构建项目
npm run build
# 本地测试
node build/index.js
项目结构
gitstandup/
├── src/
│ ├── index.ts # MCP 服务器设置和工具定义
│ ├── git.ts # Git 操作和提交记录收集
│ └── config.ts # 配置管理
├── build/ # 编译后的 JavaScript(自动生成)
└── package.json
📝 配置
仓库路径存储在 ~/.gitstandup/config.json 中:
{
"repos": ["/Users/you/projects/project1", "/Users/you/projects/project2"]
}
你可以手动编辑此文件,也可以使用 add_repos 和 remove_repos 工具进行操作。
📦 发布到 MCP 注册表
该服务器可通过 GitHub MCP 注册表 和 开源 MCP 社区注册表 被发现。
维护者操作
要发布新版本,请按以下步骤操作:
- 更新两个文件中的版本号:
# 更新 package.json 和 server.json 中的版本号
npm version patch # 或 minor/major
- 构建并发布到 npm:
npm run build
npm publish
- 安装 mcp-publisher(仅首次需要):
brew install mcp-publisher
# 或者
curl -L "https://github.com/modelcontextprotocol/registry/releases/latest/download/mcp-publisher_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar xz mcp-publisher && sudo mv mcp-publisher /usr/local/bin/
- 进行身份验证(仅首次需要):
mcp-publisher login github
- 更新 server.json 中的版本号以匹配 package.json 并发布:
mcp-publisher publish
服务器将自动出现在 GitHub MCP 注册表和社区注册表中,从而在 VS Code、Claude Desktop 和其他 MCP 兼容客户端中可被发现。
🤝 贡献
欢迎贡献代码!你可以:
- 🐛 报告 bug
- 💡 提出新功能建议
- 🔧 提交拉取请求
详情请参阅 CONTRIBUTING.md。
📄 许可证
本项目采用 MIT 许可证,详情请参阅 LICENSE。
🙏 致谢
本项目基于以下工具构建:
⚠️ 重要提示
此工具仅读取 Git 提交历史记录,不会修改你的仓库。
微信扫一扫