使用说明
🌿 Gitrama MCP服务器
为您的IDE提供AI驱动的Git智能——智能提交、分支名称、PR描述、差异、代码审查、推送和工作流管理。
这是什么?
Gitrama MCP服务器公开 Gitrama的CLI为 15个MCP工具 任何AI助手都可以使用。而不是打字 gtr commit 在您的终端中,您的AI助手直接调用该工具——分析您的代码更改、生成提交消息、建议分支名称、查看代码等等。
适用于: 光标·克劳德桌面·克劳德代码·Windsurf·VS代码·Zed·任何兼容MCP的客户端
v1.3.2的新增功能
- 5个新工具 —
gitrama_scan,gitrama_diff,gitrama_review,gitrama_status,以及gitrama_push - 健康检查中出现的版本 —
gitrama_health现在返回MCP服务器版本,以便您可以准确确认正在运行的内容 - 交互式HTML差异面板 —
gitrama_diff启动一个浏览器面板,在每个更改的文件上叠加风险注释差异、流失率、耦合上下文和贡献者信息 - 聊天推送 —
gitrama_push支持上游跟踪、强制租赁和自动解析当前分支 - 远程MCP服务器 --通过以下方式从任何地方连接
https://mcp.gitrama.ai/mcp,无需本地安装 - 刀具数量从10更新→ 15
安装(<60秒)
步骤1:安装软件包
pip install gitrama-mcp
或者使用紫外线:
uv pip install gitrama-mcp
这将安装MCP服务器和 gitrama CLI。
步骤2:连接到IDE
Cursor
添加 .cursor/mcp.json 在您的项目(或全局设置)中:
{
"mcpServers": {
"gitrama": {
"command": "gitrama-mcp",
"env": {
"GITRAMA_TOKEN": "your_token_here"
}
}
}
}
Claude Desktop
添加 claude_desktop_config.json:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 窗户:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"gitrama": {
"command": "gitrama-mcp",
"env": {
"GITRAMA_TOKEN": "your_token_here"
}
}
}
}
Claude Code
claude mcp add gitrama gitrama-mcp
VS Code
添加 .vscode/mcp.json:
{
"mcpServers": {
"gitrama": {
"command": "gitrama-mcp",
"env": {
"GITRAMA_TOKEN": "your_token_here"
}
}
}
}
Windsurf
添加 ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"gitrama": {
"command": "gitrama-mcp",
"env": {
"GITRAMA_TOKEN": "your_token_here"
}
}
}
}
Zed
添加到Zed设置(⌘,):
{
"context_servers": {
"gitrama": {
"command": {
"path": "gitrama-mcp"
},
"env": {
"GITRAMA_TOKEN": "your_token_here"
}
}
}
}
Remote — no local install required
直接连接到托管的Gitrama MCP服务器。适用于Claude.ai、Claude Desktop、Cursor、Windsurf、VS Code和任何兼容MCP的客户端:
{
"mcpServers": {
"gitrama": {
"url": "https://mcp.gitrama.ai/mcp",
"env": {
"GITRAMA_TOKEN": "your_token_here"
}
}
}
}
或通过Smithery安装:
smithery mcp add GitramaLLC/gitrama-mcp
步骤3:完成。
问你的AI: “提交我的分阶段更改” --看着它叫 gitrama_commit.
工具(15)
健康与诊断
| 工具 | 说明 |
|---|---|
gitrama_health |
检查AI服务器运行状况并确认MCP服务器版本 |
存储库智能
| 工具 | 说明 |
|---|---|
gitrama_ask |
询问有关回购的任何问题——所有权、历史、风险、变更 |
gitrama_scan |
全结构健康扫描——连续性风险、边界熵、复发模式 |
gitrama_status |
使用AI解释显示工作树状态 |
代码审查与差异
| 工具 | 说明 |
|---|---|
gitrama_diff |
带有交互式HTML面板的风险注释差异——流失、耦合、贡献者上下文 |
gitrama_review |
推送前的AI代码审查——安全性、正确性、风险、耦合性 |
提交情报
| 工具 | 说明 |
|---|---|
gitrama_commit |
为阶段性更改生成AI提交消息 |
gitrama_stage_and_commit |
一步完成阶段文件+提交 |
gitrama_unstage |
从暂存中删除文件而不丢弃更改 |
分支与推送管理
| 工具 | 说明 |
|---|---|
gitrama_branch |
从自然语言描述创建分支 |
gitrama_push |
通过上游将当前分支推送到远程,并通过租赁支持强制执行 |
公关与变更日志
| 工具 | 说明 |
|---|---|
gitrama_pr |
从分支差异生成PR描述 |
gitrama_changelog |
在引用之间生成更改日志 |
流(工作流)管理
| 工具 | 说明 |
|---|---|
gitrama_stream_status |
显示当前工作流流 |
gitrama_stream_switch |
切换到其他流 |
gitrama_stream_list |
列出仓库中的所有流 |
工具详细信息
gitrama_health
检查AI服务器连接并确认正在运行的MCP服务器版本。
示例提示: “运行gitrama健康检查”
输出示例:
✅ AI server is healthy!
🤖 Model: grok-4.20-reasoning
🌐 Connected to: https://api.x.ai/v1
🔖 Gitrama MCP Server: v1.3.2
gitrama_scan
对存储库运行完整的结构健康扫描。对每个文件的连续性风险、边界熵和重复模式进行评分。结果缓存在 last_scan.json 供使用 gtr diff 和 gtr review.
示例提示: “运行我的仓库的完整gitrama扫描”
gitrama_diff
显示当前更改的风险注释差异。打开一个 交互式HTML浏览器面板 Gitrama的结构智能叠加在一起——风险评分、流失率、耦合差距和每个更改文件的贡献者上下文。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
target |
字符串 | "" |
分支机构或承诺对 |
staged bool的。 false |
仅限不同阶段的更改 |
示例提示:
- “向我展示我的阶段性更改的差异”
- “将我的分支与主分支区分开来”
gitrama_review
对当前更改进行AI代码审查 在承诺之前。返回严重性分级的结果——安全性、正确性、风险、耦合性——以及一个判断和建议的提交消息。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
mode |
字符串 | "staged" |
"staged", "uncommitted", "quick", "full" |
示例提示:
- “查看我的阶段性更改”
- “对我所有未提交的更改进行全面审查”
gitrama_push
将当前分支推送到远程存储库。用途 --force-with-lease 为了安全起见,如果没有指定,则推送并自动解析当前分支。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
remote |
字符串 | "origin" |
远程推送 |
branch |
字符串 | "" |
要推送的分支(默认:当前分支) |
force bool的。 false |
用力推 --force-with-lease |
||
set_upstream bool的。 false |
设置上游跟踪分支(-u) |
示例提示:
- “推送我的更改”
- “推送此分支并设置为上游”
- “强制推送当前分支”
gitrama_status
使用AI解释分阶段、未分阶段和未跟踪的文件来显示工作树状态。
示例提示: “我目前的git状态是什么?”
gitrama_ask
问一个关于你的存储库的自然语言问题。Gitrama分析提交历史、文件结构、责任数据和差异来回答。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
question |
字符串 | 必需的 | 关于您的回购有任何问题吗 |
stream |
字符串 | "" |
可选的流上下文覆盖 |
deep bool的。 false |
启用完整的回购历史访问 |
示例提示:
- “谁拥有身份验证模块?”
- “此仓库中风险最大的文件是什么?”
- “过去三天发生了什么变化?”
- “解释src/utils/retry.py的用途”
gitrama_commit
为阶段性更改生成AI驱动的提交消息。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
message |
字符串 | "" |
可选自定义消息(跳过AI生成) |
示例提示: “提交我的分阶段更改”
gitrama_stage_and_commit
一步完成文件和提交。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
files |
字符串 | "." |
要暂存的文件(. 对于所有或空间分隔的路径) |
message |
字符串 | "" |
可选自定义消息 |
示例提示: “阶段并提交我的所有更改”
gitrama_unstage
从暂存区删除文件,但不丢弃更改。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
files |
字符串 | "" |
用空格分隔文件路径以取消暂存 |
all_files bool的。 false |
取消当前上演的一切 |
示例提示: “取消标记src/auth.py”
gitrama_branch
根据描述生成AI驱动的分支名称,并可选择创建它。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
description |
字符串 | 必需的 | 你正在做什么 |
create bool的。 true |
创建并切换到分支 |
示例提示:
- “创建一个分支以添加OAuth2支持”
- 建议一个分支机构名称来修复付款超时,不要创建它
gitrama_pr
根据当前分支和基础之间的差异生成PR描述。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
base |
字符串 | "" |
目标分支(默认:主/主) |
示例提示: “为此分支编写PR描述”
gitrama_changelog
在引用之间生成更改日志。
参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
since |
字符串 | "" |
起始引用(标签、分支、哈希) |
until |
字符串 | "" |
结束参考(默认值:HEAD) |
format |
字符串 | "markdown" |
"markdown" 或 "json" |
示例提示: “生成自v1.1.4以来的更改日志”
流工具
| 工具 | 参数 | 示例提示 |
|---|---|---|
gitrama_stream_status |
没有 | “我在哪条小溪上?” |
gitrama_stream_switch |
name, description |
“切换到修补程序流” |
gitrama_stream_list |
没有 | “列出我的所有gitrama流” |
v1.3.2工作流程
连接所有15个工具后,您的完整开发循环将从聊天开始运行:
describe intent → stream switch
write code
ask gitrama what changed → diff (HTML panel)
review before push
commit with AI message
push
PR description generated
没有终端。没有手动git命令。
配置
环境变量
| 变量 | 默认值 | 描述 |
|---|---|---|
GITRAMA_TOKEN |
"" |
您的Gitrama API密钥 |
GTR_CWD |
os.getcwd() |
git操作的工作目录 |
GTR_MCP_TRANSPORT |
"stdio" |
运输: "stdio" 或 "streamable-http" |
GTR_MCP_HOST |
"0.0.0.0" |
HTTP主机(使用流式HTTP时) |
GTR_MCP_PORT |
"8765" |
HTTP端口(使用流式HTTP时) |
HTTP传输(用于CI/CD)
GTR_MCP_TRANSPORT=streamable-http GTR_MCP_PORT=8765 gitrama-mcp
然后将您的客户端连接到 http://localhost:8765/mcp.
需求
- Python 3.10+
- Git已安装并位于PATH中
- Gitrama API密钥或本地Ollama实例
设置API密钥:
gtr config --key YOUR_API_KEY
或者使用本地模型:
gtr config --provider ollama --model llama3
发展
git clone https://github.com/GitramaLLC/gitrama-mcp.git
cd gitrama-mcp
pip install -e ".[dev]"
# Test with MCP Inspector
mcp dev src/gitrama_mcp/server.py
许可证
专有——见 许可证.
建造于 阿方索哈丁 · gitrama.ai
🌿
