Git MCP

🚀 Git MCP 使用指南

用於管理本地倉庫中Git操作的MCP服務器。

🚀 快速開始

Git MCP 是用於管理本地倉庫中 Git 操作的 MCP 服務器，下面將為你介紹其安裝、配置、使用等相關內容。

✨ 主要特性

• 支持通過 Smithery 自動安裝和手動安裝兩種方式。
• 可通過 JSON 配置代碼片段添加 MCP 服務器。
• 提供多種功能方法，如列出倉庫、獲取標籤、列出提交信息等。
• 具備完善的故障排除說明和測試機制。

📦 安裝指南

通過 Smithery 安裝

要自動通過 Smithery 為 Claude 桌面安裝 Git MCP，可使用以下命令：

npx -y @smithery/cli install @kjozsa/git-mcp --client claude

手動安裝

uvx install git-mcp

📚 詳細文檔

配置說明

使用以下 JSON 配置代碼片段添加 MCP 服務器：

{
  "mcpServers": {
    "git-mcp": {
      "command": "uvx",
      "args": ["git-mcp"],
      "env": {
        "GIT_REPOS_PATH": "/path/to/your/git/repositories"
      }
    }
  }
}

功能與使用方法

環境變量

• GIT_REPOS_PATH：包含 Git 倉庫的目錄路徑（必填）。 你可以在運行服務器的目錄中創建一個 .env 文件，或者將其添加到你的環境中。

可用方法

• list_repositories：列出配置路徑下的所有 Git 倉庫。
  • 參數：無
  • 返回值：倉庫名稱列表
• get_last_git_tag：獲取指定倉庫中的最後一個 Git 標籤。
  • 參數：
    • repo_name（必填）：Git 倉庫的名稱
  • 返回值：包含 version（標籤名稱）和 date（創建日期）的字典
• list_commits_since_last_tag：列出從最後一個 Git 標籤到最新提交之間的提交信息。
  • 參數：
    • repo_name：Git 倉庫的名稱
    • max_count（可選）：返回的最大提交數量
  • 返回值：包含 hash、author、date 和 message 的字典列表
• create_git_tag：在指定倉庫中創建新的 Git 標籤。
  • 參數：
    • repo_name：Git 倉庫的名稱
    • tag_name：要創建的標籤名稱
    • message（可選）：註釋信息（如果未提供，默認創建輕量級標籤）
  • 返回值：包含 status、version（標籤名稱）、date（創建日期）和 type（註釋或輕量級）的字典
• push_git_tag：將現有的 Git 標籤推送到默認遠程倉庫。
  • 參數：
    • repo_name：Git 倉庫的名稱
    • tag_name：要推送的標籤名稱
  • 返回值：包含 status、remote（遠程名稱）、tag（標籤名稱）和 message（成功消息）的字典
• refresh_repository：通過檢查出 main 分支（或回退到 master 分支作為備用）並拉取最新更改來刷新倉庫。
  • 參數：
    • repo_name：Git 倉庫的名稱
  • 返回值：無返回值，操作完成後輸出狀態信息

故障排除

未找到倉庫

如果你看到類似“找不到倉庫”的錯誤，請檢查以下內容：

1. 確保路徑 /path/to/your/git/repositories 是有效的，並且包含 Git 倉庫。
2. 確保倉庫名稱拼寫正確。

提交為空

如果返回的提交列表為空，請執行以下操作：

1. 檢查是否已創建標籤。
2. 確認倉庫中是否有任何提交記錄。

開發說明

uv pip install -r requirements.txt

測試說明

要運行測試：

# 對於基本功能測試
uvx test

# 對於擴展功能測試
python3 tests.py

測試腳本

• test：對核心功能進行快速測試。
• tests.py：提供更全面的測試，涵蓋更多使用場景。

通過以上指南，你可以輕鬆配置和使用 Git MCP 服務器來管理你的 Git 倉庫。