📝 更新說明文檔

This commit is contained in:
Minidoracat 2025-06-02 13:24:34 +08:00
parent 27e48a3a91
commit e24269ecff
2 changed files with 44 additions and 6 deletions

View File

@ -50,6 +50,9 @@ Both interfaces support:
- 💬 Text feedback input - 💬 Text feedback input
- 🖼️ Image upload (supports drag & drop, clipboard paste) - 🖼️ Image upload (supports drag & drop, clipboard paste)
- ⚡ Real-time command execution - ⚡ Real-time command execution
- ⌨️ **Keyboard Shortcuts**:
- Ctrl+Enter for quick feedback submission (supports main keyboard and numpad)
- Ctrl+V to paste images directly in feedback dialog
- 🎨 Modern dark theme - 🎨 Modern dark theme
- 📱 Responsive design (Web UI) - 📱 Responsive design (Web UI)
- 🌐 Multi-language support (Traditional Chinese, English, Simplified Chinese) - 🌐 Multi-language support (Traditional Chinese, English, Simplified Chinese)
@ -190,6 +193,19 @@ If you need to use source version or want to customize environment variables:
**Remember to modify the path to your actual project directory!** **Remember to modify the path to your actual project directory!**
## 🔄 Workflow
1. **AI Assistant Call** - AI calls `mcp-feedback-enhanced` after completing tasks
2. **Environment Detection** - System automatically detects runtime environment
3. **Interface Launch** - Launches Qt GUI or Web UI based on environment
4. **User Interaction** - Users can:
- Execute commands and view output
- Provide text feedback (supports Ctrl+Enter quick submission, compatible with main keyboard and numpad)
- Upload images (drag & drop, clipboard paste Ctrl+V)
- Use multi-language interface switching
5. **Feedback Delivery** - User feedback (including images) is sent back to AI assistant
6. **Process Continuation** - AI continues or ends task based on feedback
## 🧪 Testing and Development ## 🧪 Testing and Development
### Testing with uvx ### Testing with uvx
@ -215,7 +231,16 @@ MCP_DEBUG=true uvx mcp-feedback-enhanced@latest test
## 🆕 Version History ## 🆕 Version History
### v2.0.9 - Multi-language Architecture Enhancement (Latest) ### v2.0.14 - Enhanced Keyboard Shortcuts (Latest)
- ⌨️ **Numpad Support**: Ctrl+Enter shortcut now supports both main keyboard and numpad Enter keys
- 🖼️ **Smart Image Pasting**: Ctrl+V can directly paste clipboard images in feedback dialog without additional upload steps
- 🎮 **Dual Shortcut Mechanism**: GUI uses dual QShortcut setup ensuring full compatibility
- 🌐 **Web UI Shortcut Enhancement**: Uses key/code dual detection mechanism supporting all Enter key variants
- 💡 **User Experience Improvements**: Updated trilingual hint texts clearly indicating numpad support and image pasting functionality
- 🔧 **API Simplification**: Removed `force_web_ui` parameter, simplified API design with only environment variable control
- 📝 **Documentation Updates**: Updated all related documentation, removed redundant examples
### v2.0.9 - Multi-language Architecture Enhancement
- 🌏 **Complete Multi-language Architecture Restructuring**: Migrated from embedded translations to structured JSON-based system - 🌏 **Complete Multi-language Architecture Restructuring**: Migrated from embedded translations to structured JSON-based system
- 📁 **Organized Language Files**: Separated language files into `src/mcp_feedback_enhanced/locales/` directory structure - 📁 **Organized Language Files**: Separated language files into `src/mcp_feedback_enhanced/locales/` directory structure
- 🔧 **Enhanced Internationalization**: Dynamic loading with nested key structure and browser language detection - 🔧 **Enhanced Internationalization**: Dynamic loading with nested key structure and browser language detection

View File

@ -50,6 +50,9 @@
- 💬 文字回饋輸入 - 💬 文字回饋輸入
- 🖼️ 圖片上傳(支援拖拽、剪貼板粘貼) - 🖼️ 圖片上傳(支援拖拽、剪貼板粘貼)
- ⚡ 即時命令執行 - ⚡ 即時命令執行
- ⌨️ **快捷鍵支援**
- Ctrl+Enter 快速提交回饋(支援主鍵盤和數字鍵盤)
- Ctrl+V 直接在回饋對話框中貼上剪貼板圖片
- 🎨 現代化深色主題 - 🎨 現代化深色主題
- 📱 響應式設計Web UI - 📱 響應式設計Web UI
- 🌐 多語言支援(繁體中文、英文、簡體中文) - 🌐 多語言支援(繁體中文、英文、簡體中文)
@ -326,9 +329,6 @@ uv run fastmcp dev src/mcp_feedback_enhanced/server.py
```bash ```bash
# 啟用調試模式測試 # 啟用調試模式測試
MCP_DEBUG=true uvx mcp-feedback-enhanced@latest test MCP_DEBUG=true uvx mcp-feedback-enhanced@latest test
# 強制使用 Web UI
FORCE_WEB=true uvx mcp-feedback-enhanced@latest test
``` ```
## 📖 使用範例 ## 📖 使用範例
@ -408,13 +408,26 @@ AI 助手會如此調用 `mcp-feedback-enhanced` 工具:
1. **AI 助手調用** - AI 完成任務後調用 `mcp-feedback-enhanced` 1. **AI 助手調用** - AI 完成任務後調用 `mcp-feedback-enhanced`
2. **環境檢測** - 系統自動檢測運行環境 2. **環境檢測** - 系統自動檢測運行環境
3. **介面啟動** - 根據環境啟動 Qt GUI 或 Web UI 3. **介面啟動** - 根據環境啟動 Qt GUI 或 Web UI
4. **用戶互動** - 用戶可以執行命令、查看輸出、提供文字回饋、上傳圖片 4. **用戶互動** - 用戶可以:
- 執行命令和查看輸出
- 提供文字回饋(支援 Ctrl+Enter 快速提交,相容主鍵盤和數字鍵盤)
- 上傳圖片(拖拽、剪貼板粘貼 Ctrl+V
- 使用多語言介面切換
5. **回饋傳遞** - 用戶回饋(包括圖片)傳回給 AI 助手 5. **回饋傳遞** - 用戶回饋(包括圖片)傳回給 AI 助手
6. **流程繼續** - AI 根據回饋繼續或結束任務 6. **流程繼續** - AI 根據回饋繼續或結束任務
## 🆕 版本更新 ## 🆕 版本更新
### v2.0.9 - 多語言架構重構(最新版) ### v2.0.14 - 增強快捷鍵支援(最新版)
- ⌨️ **數字鍵盤支援**Ctrl+Enter 快捷鍵現在同時支援主鍵盤和數字鍵盤的 Enter 鍵
- 🖼️ **智能圖片貼上**Ctrl+V 可直接在回饋對話框中貼上剪貼板圖片,無需額外上傳步驟
- 🎮 **雙重快捷鍵機制**GUI 使用 QShortcut 雙重設定,確保完整相容性
- 🌐 **Web UI 快捷鍵增強**:使用 key/code 雙重檢測機制,支援所有 Enter 鍵變體
- 💡 **使用者體驗改善**:更新三語言提示文字,明確標示數字鍵盤支援和圖片貼上功能
- 🔧 **API 簡化**:移除 `force_web_ui` 參數,簡化 API 設計,只保留環境變數控制
- 📝 **文件更新**:更新所有相關說明文件,移除冗餘範例
### v2.0.9 - 多語言架構重構
- 🌏 **完整多語言架構重構**:從嵌入式翻譯遷移到結構化 JSON 基礎系統 - 🌏 **完整多語言架構重構**:從嵌入式翻譯遷移到結構化 JSON 基礎系統
- 📁 **語言檔案組織化**:將語言檔案分離到 `src/mcp_feedback_enhanced/locales/` 目錄結構 - 📁 **語言檔案組織化**:將語言檔案分離到 `src/mcp_feedback_enhanced/locales/` 目錄結構
- 🔧 **增強國際化功能**:動態載入與嵌套鍵值結構,支援瀏覽器語言偵測 - 🔧 **增強國際化功能**:動態載入與嵌套鍵值結構,支援瀏覽器語言偵測