README
🚀 Git 法证 MCP 服务器
Git 法证 MCP 服务器是一款专门用于深入剖析大型 Git 代码库的工具。它基于 Model Context Protocol (MCP) 构建,专注于对 Git 存储库进行分析,能提供存储库历史记录、分支关系以及开发模式的详细信息,而非进行通用的 GitHub 或 Git 操作。
🚀 快速开始
服务器作为 MCP 服务运行,可以与任何兼容的 MCP 客户端集成。所有分析结果将以 JSON 格式写入指定的输出文件。
✨ 主要特性
该服务器提供了四个主要分析工具:
- 分支概述 (
get_branch_overview)- 提供分支状态和关系的高级别视图。
- 分析最后提交、提交次数和合并基线。
- 生成分支活动的统计摘要。
- 时间段分析 (
analyze_time_period)- 分析特定时间范围内的详细开发活动。
- 对提交进行分类(功能、修复、重构、文档、其他)。
- 提供按提交模式划分的活动摘要。
- 文件更改分析 (
analyze_file_changes)- 跟踪特定文件在不同分支中的更改情况。
- 识别潜在冲突区域。
- 提供风险评估。
- 根据风险级别生成推荐审查顺序。
- 合并建议 (
get_merge_recommendations)- 确定最佳的合并策略。
- 评估冲突风险。
- 识别代码热点。
- 提供分步合并指导。
📦 安装指南
依赖项
- @modelcontextprotocol/sdk
- Node.js
- Git(必须安装且可执行)
💻 使用示例
基础用法
每个工具都需要特定的参数:
- `repoPath`:Git 存储库路径
- `branches`:要分析的分支名称数组
- `outputPath`:分析结果写入的位置
- 其他工具特定参数:
- `timeRange`:时间段分析的开始和结束日期
- `files`:文件路径数组,用于文件更改分析
📚 详细文档
输出格式
所有工具输出 JSON 文件,包含:
- 详细分析结果
- 总结统计信息
- 风险评估(如适用)
- 基于分析的建议
🔧 技术细节
- 使用 TypeScript 实现。
- 使用 MCP SDK 进行服务器实现。
- 通过子进程执行 Git 命令。
- 提供错误处理和验证机制。
- 在 stdio 传输上运行。
📄 许可证
该项目在 Apache 许可证 2.0 下开源,具体许可证内容请参阅 LICENSE.txt 文件。
欢迎协作
欢迎 Fork 和贡献。所有贡献均基于 Apache 许可证 2.0。此宽松许可允许您:
- 商业用途
- 修改和分发代码
- 创建衍生作品
- 包含在其他项目中
版权 2025。根据 Apache 许可证 2.0 使用,除非遵守许可证,否则不得使用该项目。许可证副本请访问 http://www.apache.org/licenses/LICENSE-2.0
Scan to join WeChat group