Git Auto Commit

🚀 Git 自動提交服務器 🛠️

本項目提供了一個 Git 更改分析器，藉助 OpenAI 的 GPT 模型來自動生成提交信息，極大提升了 Git 提交的效率與準確性。

🚀 快速開始

克隆倉庫

git clone https://github.com/jatinsandilya/mcp-server-auto-commit.git
cd mcp-server-auto-commit

安裝依賴項

pnpm install

設置 OpenAI API 密鑰

您可以通過以下任意一種方式設置 OpenAI API 密鑰：

• 作為環境變量：OPENAI_API_KEY=your-api-key
• 通過命令行參數傳遞：--key your-api-key
• 添加到項目根目錄的 .env 文件中

構建項目

pnpm run build

此命令將生成 /build/index.js 文件，即編譯後的 MCP 服務器腳本。

使用 Cursor

1. 打開設置 -> MCP -> 添加新的 MCP 服務器
2. 配置您的 MCP：
   • 名稱：git-auto-commit
   • 類型：命令
   • 命令：node ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js --key your-api-key （請將 your-api-key 替換為實際的 OpenAI API 密鑰，若未在環境變量中設置）

使用 Claude Desktop

在您的 Claude Desktop 配置中添加以下 MCP 配置：

{
  "mcpServers": {
    "git-auto-commit": {
      "command": "node",
      "args": ["ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js", "--key", "your-api-key"]
    }
  }
}

✨ 主要特性

• 智能更改分析：可分析 Git 存儲庫中的更改，涵蓋已暫存和未暫存的更改。
• 智能提交信息生成：利用 GPT - 4o - mini 模型生成常規提交信息。
• 詳細總結：
  • 📝 清晰列出修改的文件。
  • ✨ 明確展示新增的文件。
  • 🗑️ 準確呈現刪除的文件。
  • 📄 展示文件的詳細更改（每個文件最多顯示 10 行）。
• 強大構建工具：使用 @modelcontextprotocol/sdk 構建。
• 自動簽名：每次提交都會添加自動簽名。

📦 安裝指南

先決條件

• 已安裝 Node.js
• 擁有 OpenAI API 密鑰
• 具備要分析的 Git 存儲庫
• 安裝了 pnpm 包管理器

安裝步驟

1. 克隆倉庫：git clone https://github.com/jatinsandilya/mcp-server-auto-commit.git
2. 進入項目目錄：cd mcp-server-auto-commit
3. 安裝依賴：pnpm install
4. 設置 API 密鑰
5. 構建項目：pnpm run build

💻 使用示例

基礎用法

在終端中運行以下命令啟動 MCP 服務器，並監聽來自集成工具的請求：

node build/index.js

📚 詳細文檔

項目結構

mcp-server-auto-commit/
├── index.ts        # 主服務器實現文件，包含Git分析工具
├── package.json    # 項目依賴管理
├── tsconfig.json   # TypeScript 配置文件
└── build/         # 編譯輸出 JavaScript 文件

可用工具

git - changes - commit - message

此工具用於分析當前 Git 存儲庫中的更改，並使用 OpenAI 的 GPT - 4o - mini 模型生成提交信息。它會提供以下內容：

• 修改文件的列表及其狀態指示器
• 新增文件的列表
• 刪除文件的列表
• 每個文件的詳細更改（每個文件最多顯示 10 行）
• 符合常規提交格式的生成提交信息
• 自動提交簽名

使用參數：

• autoCommitPath：可選路徑，用於指定要分析的具體路徑

如何使用

安裝依賴

pnpm install

構建項目

pnpm run build

運行服務器

構建完成後，運行生成的可執行文件（根據平臺有所不同）。

🔧 技術細節

本項目使用 Node.js 作為運行環境，藉助 TypeScript 進行開發。主服務器實現文件 index.ts 包含了 Git 分析工具，項目依賴通過 package.json 進行管理，TypeScript 配置則由 tsconfig.json 完成。編譯後的 JavaScript 文件會輸出到 build/ 目錄。同時，項目使用 @modelcontextprotocol/sdk 構建，利用 GPT - 4o - mini 模型生成提交信息。

📄 許可證

[此處填寫許可證信息]

聯繫方式

如需聯繫，請發送郵件至 [your.email@example.com] 或訪問項目主頁。

演示

⚠️ 重要提示

• 請確保安裝了最新版本的 Node.js 和 pnpm。
• 務必驗證 OpenAI API 密鑰是否有效。
• 檢查防火牆設置，確保服務器可以訪問互聯網。

💡 使用建議

建議在使用前仔細檢查 OpenAI API 密鑰的設置，避免因密鑰無效導致無法正常生成提交信息。同時，定期更新項目依賴，以保證項目的穩定性和安全性。

貢獻指南

歡迎貢獻！請 fork 此倉庫並提交拉取請求。