Autobuildmcp

🚀 AutoBuildMCP：基於MCP的自動化構建服務器

AutoBuildMCP是一款強大的、基於配置文件的自動化構建服務器，由模型上下文協議（MCP）提供支持。它允許符合MCP標準的客戶端（如Cursor）無縫管理、執行和監控多個項目的構建過程。

該服務器採用持久化、有狀態的架構，使用構建隊列來管理併發操作，避免系統過載。

✨ 主要特性

• 基於配置文件的管理：為每個項目定義獨特的構建“配置文件”。每個配置文件封裝了項目路徑、構建命令、環境變量和超時時間。
• 持久化狀態：所有構建配置文件都存儲在一個簡單的builds.json文件中，確保服務器重啟後配置仍然保留。
• 構建隊列系統：一個複雜的隊列系統管理一組併發構建（默認：2個），防止服務器因多個併發請求而過載。新的構建會排隊等待，一旦有可用插槽就會執行。
• 異步、非阻塞執行：構建作為後臺進程運行，允許服務器在構建進行時保持響應並處理其他API調用。
• 全生命週期管理：一套完整的工具，用於配置、啟動、監控、停止和刪除構建。
• 日誌捕獲：每次構建運行的完整stdout和stderr都會捕獲到一個專用日誌文件中，便於調試。
• 重啟恢復能力：如果服務器在構建執行期間重啟，服務器會智能檢測並將構建標記為“未知”，防止出現卡住的“運行中”狀態。

📦 安裝指南

安裝過程在Windows和Linux/macOS環境下都很簡單。

1. 構建環境

此腳本將創建一個Python虛擬環境，並從requirements.txt安裝所有必要的依賴項，包括用於進程管理的psutil。

在Windows上：

.\build.bat

在Linux/macOS上：

./build.sh

2. 運行服務器

這將啟動AutoBuildMCP服務器及其後臺構建工作進程。服務器將在http://localhost:5307可用。

在Windows上：

.\run.bat

在Linux/macOS上：

./run.sh

現在服務器已運行，準備好接受來自MCP客戶端的請求。

📚 詳細文檔

服務器提供了一組工具，任何符合MCP標準的客戶端都可以調用這些工具。

configure_build

創建或更新一個構建配置文件。

• profile_name (str)：配置文件的唯一名稱（例如，my-web-app）。
• project_path (str)：項目根目錄的絕對或相對路徑。
• build_command (str)：執行構建的shell命令（例如，npm run build）。
• environment (dict, 可選)：為構建過程設置的環境變量字典。
• timeout (int, 可選)：構建的超時時間（以秒為單位，尚未實現）。

toggle_autobuild

啟用或禁用某個配置文件的自動構建文件監視器。

• profile_name (str)：要修改的配置文件的名稱。
• enabled (bool)：設置為true以啟用自動構建，或設置為false以禁用它。

list_builds

列出所有已配置的構建配置文件及其最後已知狀態。

get_build_status

檢索特定構建配置文件的當前狀態。

• profile_name (str)：要檢查的配置文件的名稱。
• 返回值：狀態，可以是configured、queued、running、succeeded、failed、stopped或unknown。

start_build

將某個配置文件的構建請求添加到隊列中。

• profile_name (str)：要構建的配置文件的名稱。
• 返回值：確認消息和構建在隊列中的位置。

stop_build

停止當前正在運行的構建。

• profile_name (str)：要停止的正在運行的配置文件的名稱。

delete_build_profile

從服務器中刪除一個構建配置文件。

• profile_name (str)：要刪除的配置文件的名稱。

get_build_log

檢索某個配置文件最後一次運行的日誌文件。

• profile_name (str)：配置文件的名稱。
• lines (int, 可選)：如果提供，則只返回日誌的最後N行（日誌尾部）。

自動構建系統

服務器包含一個強大的自動構建系統，可以按配置文件啟用。

工作原理

1. 啟用：使用toggle_autobuild工具為特定配置文件啟用此功能。
2. 監控：服務器將開始監控配置文件的project_path中的任何文件更改。
3. 去抖動：當檢測到更改時，一個5秒的倒計時計時器開始。如果發生另一次更改，計時器將重置。這可以防止在保存多個文件時引發大量構建。
4. 觸發：一旦計時器完成，服務器將檢查配置文件的狀態：
   • 如果配置文件空閒，則將一個新的構建添加到隊列中。
   • 如果配置文件忙碌（running或queued），則設置一個rebuild_on_completion標誌。構建工作進程將在當前構建完成後自動重新排隊構建。

builds.json狀態文件

此文件是服務器的核心，存儲所有配置文件配置及其最後運行狀態。您可以查看它以瞭解系統的當前狀態。

builds.json示例：

{
  "my-web-app": {
    "project_path": "C:/Users/Admin/projects/my-app",
    "build_command": "npm install && npm run build",
    "environment": {
      "NODE_ENV": "production"
    },
    "timeout": 600,
    "status": "succeeded",
    "autobuild_enabled": true,
    "rebuild_on_completion": false,
    "last_run": {
      "run_id": "08f7e57e-e46c-4ac3-b564-f3588018b9fd",
      "pid": 12052,
      "start_time": "2025-06-29T22:45:00.123456Z",
      "end_time": "2025-06-29T22:46:12.123456Z",
      "log_file": "logs/08f7e57e-e46c-4ac3-b564-f3588018b9fd.log",
      "outcome_note": "Build status is unknown; server was restarted during execution."
    }
  }
}