mirror of https://github.com/Minidoracat/mcp-feedback-enhanced.git synced 2025-07-27 10:42:25 +08:00

Minidoracat 1e02a21f7e 📄 更新 README.md，新增 MCP 互動回饋的基本提示與完整規則範例，調整安裝說明以推薦使用 uvx 安裝方法，並更新測試與配置範例以反映最新的命令與結構，提升使用者對於安裝與配置的理解。

2025-05-31 03:42:31 +08:00

10 KiB

Raw Blame History

Interactive Feedback MCP（互動回饋 MCP）

原作者： Fábio Ferreira
分支版本： Minidoracat
相關資源： dotcursorrules.com 提供更多 AI 開發增強工具

這是一個簡單的 MCP 伺服器，用於在 AI 輔助開發工具（如 Cursor）中實現人在回路（human-in-the-loop）的工作流程。該伺服器允許您執行命令、查看輸出並直接向 AI 提供文字回饋。同時支援 Cline 和 Windsurf。

✨ 新功能：Web UI 支援

🌐 支援 SSH Remote 開發環境
此分支版本新增了 Web UI 功能，完美解決了 SSH remote 開發環境中無法使用 GUI 的問題：

自動環境檢測：系統會自動檢測運行環境
本地環境：使用原有的 Qt GUI 介面
SSH Remote 環境：自動切換到現代化 Web UI
即時通訊：基於 WebSocket 的即時命令輸出和回饋
深色主題：提供現代化的深色主題界面

🎯 為什麼使用這個工具？

透過引導 AI 助手與用戶進行確認，而非進行推測性的高成本工具調用，此模組可以大幅減少平台（如 Cursor）上的付費請求次數。在某些情況下，它可以將多達 25 次工具調用合併為單次回饋導向的請求，節省資源並提升效能。

📝 提示工程設定

為了獲得最佳效果，請在您的 AI 助手中添加以下自訂提示（例如在 Cursor 的規則或提示中）：

基本提示

每當你想要詢問問題時，請務必調用 MCP interactive_feedback。
每當你即將完成用戶請求時，請調用 MCP interactive_feedback 而不是直接結束流程。
持續調用 MCP 直到用戶的回饋為空，然後才結束請求。

完整規則範例

# MCP Interactive Feedback 規則

1. 在任何流程、任務、對話進行時，無論是詢問、回覆、或完成階段性任務，皆必須呼叫 MCP mcp-feedback-enhanced。
2. 每當收到使用者回饋，若回饋內容非空，必須再次呼叫 MCP mcp-feedback-enhanced，並根據回饋內容調整行為。
3. 僅當使用者明確表示「結束」或「不再需要互動」時，才可停止呼叫 MCP mcp-feedback-enhanced，流程才算結束。
4. 除非收到結束指令，否則所有步驟都必須重複呼叫 MCP mcp-feedback-enhanced。

這將確保您的 AI 助手在標記任務完成前使用此 MCP 伺服器請求用戶回饋。

🔧 環境檢測與配置

系統會自動檢測運行環境並選擇適當的介面：

Qt GUI（本地環境）

使用 Qt 的 QSettings 按專案基礎儲存配置
包含命令設定、自動執行選項、視窗幾何狀態等
設定通常儲存在平台特定位置（Windows 登錄檔、macOS plist 檔案、Linux 配置目錄）

Web UI（SSH Remote 環境）

基於 FastAPI 和 WebSocket 的現代化界面
支援即時命令執行和輸出顯示
自動瀏覽器啟動和會話管理
深色主題和響應式設計

🚀 安裝說明

方法 1：uvx 安裝（推薦）

這是最簡單的方法，無需手動管理依賴項或虛擬環境：

安裝 uv（如果尚未安裝）

# Windows
pip install uv

# Linux/Mac
curl -LsSf https://astral.sh/uv/install.sh | sh

測試安裝

# 查看版本信息
uvx mcp-feedback-enhanced version

# 執行測試
uvx mcp-feedback-enhanced test

# 持久化測試模式（可在瀏覽器中實際測試）
uvx mcp-feedback-enhanced test --persistent

方法 2：從源碼安裝（開發者）

適合需要修改代碼或貢獻開發的用戶：

取得程式碼

git clone https://github.com/Minidoracat/mcp-feedback-enhanced.git
cd mcp-feedback-enhanced

安裝依賴項
```
uv sync
```

測試安裝

# 基本功能測試
uv run python -m mcp_feedback_enhanced test

# 持久化測試模式（可在瀏覽器中實際測試）
uv run python -m mcp_feedback_enhanced test --persistent

運行 MCP 伺服器
```
uv run python -m mcp_feedback_enhanced
```

⚙️ AI 助手配置

替代配置（從源碼運行）

如果您需要使用源碼版本或想要自訂環境變數：

{
  "mcpServers": {
    "mcp-feedback-enhanced": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/mcp-feedback-enhanced",
        "run",
        "python",
        "-m",
        "mcp_feedback_enhanced"
      ],
      "timeout": 600,
      "env": {
        "FORCE_WEB": "true"
      },
      "autoApprove": [
        "interactive_feedback"
      ]
    }
  }
}

記得將路徑修改為您實際的專案目錄！

Cline / Windsurf 配置

類似的設定原則：在各工具的 MCP 設定中配置伺服器命令，使用 mcp-feedback-enhanced 作為伺服器識別符。

🧪 測試和開發

使用 uvx 測試

# 完整功能測試（推薦）
uvx mcp-feedback-enhanced test

# Qt GUI 專門測試
uvx mcp-feedback-enhanced test --gui

# Web UI 專門測試
uvx mcp-feedback-enhanced test --web

# 持久化測試模式（測試完不關閉，可互動測試）
uvx mcp-feedback-enhanced test --persistent
uvx mcp-feedback-enhanced test --gui --persistent
uvx mcp-feedback-enhanced test --web --persistent

# 查看版本
uvx mcp-feedback-enhanced version

從源碼測試

# 完整功能測試
uv run python -m mcp_feedback_enhanced test

# Qt GUI 專門測試
uv run python -m mcp_feedback_enhanced test --gui

# Web UI 專門測試
uv run python -m mcp_feedback_enhanced test --web

# 持久化測試模式
uv run python -m mcp_feedback_enhanced test --persistent

開發模式

使用 FastMCP 開發模式運行伺服器並開啟測試界面：

# 從源碼
uv run fastmcp dev src/mcp_feedback_enhanced/server.py

測試選項說明

無參數 test：執行完整測試套件（環境檢測、參數驗證、MCP 整合、Web UI）
--gui：專門測試 Qt GUI 功能和介面
--web：專門測試 Web UI 功能和 WebSocket 通訊
--persistent：持久化模式，測試完成後保持運行，方便互動測試

🌟 功能特色

🖥️ 雙介面支援

Qt GUI：適用於本地開發環境
Web UI：適用於 SSH remote 開發環境

🔍 智慧環境檢測

自動檢測 SSH 連線環境變數
檢測 DISPLAY 設定（Linux）
檢測 VSCode Remote 開發環境
自動選擇最適合的介面

💻 命令執行功能

即時命令執行和輸出顯示
支援命令中斷和程序樹終止
自動工作目錄設定
命令歷史記錄

🎨 現代化介面

深色主題設計
響應式佈局（支援手機瀏覽器）
WebSocket 即時通訊
載入動畫和視覺回饋

📖 使用範例

1. 推薦 MCP 配置（uvx）

使用 uvx 的簡潔配置：

{
  "mcpServers": {
    "mcp-feedback-enhanced": {
      "command": "uvx",
      "args": [
        "mcp-feedback-enhanced"
      ],
      "timeout": 600,
      "autoApprove": [
        "interactive_feedback"
      ]
    }
  }
}

2. 自訂環境變數配置

如需要自訂環境變數（例如強制使用 Web UI）：

{
  "mcpServers": {
    "mcp-feedback-enhanced": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/mcp-feedback-enhanced",
        "run",
        "python",
        "-m",
        "mcp_feedback_enhanced"
      ],
      "timeout": 600,
      "env": {
        "FORCE_WEB": "true"
      },
      "autoApprove": [
        "interactive_feedback"
      ]
    }
  }
}

3. 工具調用範例

AI 助手會如此調用 interactive_feedback 工具：

<use_mcp_tool>
  <server_name>mcp-feedback-enhanced</server_name>
  <tool_name>interactive_feedback</tool_name>
  <arguments>
    {
      "project_directory": "/path/to/your/project",
      "summary": "我已經實現了您請求的更改並重構了主模組。"
    }
  </arguments>
</use_mcp_tool>

4. 環境變數控制範例

在 MCP 配置中設定：

"env": {
  "FORCE_WEB": "true"    // 強制使用 Web UI
}

支援的環境變數值：

"true", "1", "yes", "on" → 強制使用 Web UI
"false", "0", "no", "off" → 使用預設邏輯
未設定 → 根據環境自動檢測

INCLUDE_BASE64_DETAIL 環境變數：

設定為 "true", "1", "yes", "on" 時在回饋中包含完整的圖片 Base64 數據
用於提高與不同 AI 助手的兼容性
預設為 false，只顯示 Base64 預覽信息

🔄 工作流程

AI 助手調用 - AI 完成任務後調用 interactive_feedback
環境檢測 - 系統自動檢測運行環境
介面啟動 - 根據環境啟動 Qt GUI 或 Web UI
用戶互動 - 用戶可以執行命令、查看輸出、提供回饋
回饋傳遞 - 用戶回饋傳回給 AI 助手
流程繼續 - AI 根據回饋繼續或結束任務

🆕 版本更新

v2.0 - Web UI 支援

✅ 新增 Web UI 介面支援 SSH remote 開發
✅ 自動環境檢測和介面選擇
✅ WebSocket 即時通訊
✅ 現代化深色主題
✅ 響應式設計支援
✅ 持久化測試模式

v1.0 - 基礎版本（原作者）

✅ Qt GUI 介面
✅ 命令執行功能
✅ MCP 協議支援
✅ 多平台支援

🙏 致謝與聯繫

原作者

Fábio Ferreira - X @fabiomlferreira
如果您覺得 Interactive Feedback MCP 有用，最好的支持方式是關注原作者的 X 帳號。

分支維護者

如有關於 Web UI 功能的問題或建議，歡迎在 GitHub Issues 中提出。

📄 授權條款

本專案採用 MIT 授權條款。詳見 LICENSE 檔案。

🌟 歡迎 Star 此專案並分享給更多開發者！

10 KiB Raw Blame History Unescape Escape