更新 README 文件,新增 v2.1.0 版本的功能亮點與界面設計,重構 Qt GUI 和 Web UI,並改善多語言支持及文件結構,刪除舊版圖片,新增新界面截圖。

This commit is contained in:
Minidoracat 2025-06-03 07:56:19 +08:00
parent c1dd8fc893
commit 48b850b1ce
15 changed files with 143 additions and 80 deletions

View File

@ -22,27 +22,43 @@ This is an [MCP server](https://modelcontextprotocol.io/) that implements **huma
## 🌟 Key Features
### 🖥️ Dual Interface System
- **Qt GUI**: Native experience for local environments
- **Web UI**: Modern interface for remote SSH environments
- **Qt GUI**: Native experience for local environments, modular refactored design
- **Web UI**: Modern interface for remote SSH environments, brand new architecture
- **Smart Switching**: Auto-detect environment and choose optimal interface
### 🎨 Brand New Interface Design (v2.1.0)
- **Modular Architecture**: Both GUI and Web UI adopt modular design
- **Centralized Management**: Reorganized folder structure for easier maintenance
- **Modern Themes**: Improved visual design and user experience
- **Responsive Layout**: Adapts to different screen sizes and window dimensions
### 🖼️ Image Support
- **Format Support**: PNG, JPG, JPEG, GIF, BMP, WebP
- **Upload Methods**: Drag & drop files + clipboard paste (Ctrl+V)
- **Auto Processing**: Smart compression to ensure 1MB limit compliance
### 🌏 Multi-language
- **Three Languages**: Traditional Chinese, English, Simplified Chinese
- **Three Languages**: English, Traditional Chinese, Simplified Chinese
- **Smart Detection**: Auto-select based on system language
- **Live Switching**: Change language directly within interface
## 🖥️ Interface Preview
![Qt GUI Interface](docs/images/gui-en.png)
*Qt GUI Interface - Local Environment*
### Qt GUI Interface (Refactored Version)
<div align="center">
<img src="docs/images/en/gui1.png" width="400" alt="Qt GUI Main Interface" />
<img src="docs/images/en/gui2.png" width="400" alt="Qt GUI Settings Interface" />
</div>
![Web UI Interface](docs/images/web-en.png)
*Web UI Interface - SSH Remote Environment*
*Qt GUI Interface - Modular refactoring, supporting local environments*
### Web UI Interface (Refactored Version)
<div align="center">
<img src="docs/images/en/web1.png" width="400" alt="Web UI Main Interface" />
<img src="docs/images/en/web2.png" width="400" alt="Web UI Settings Interface" />
</div>
*Web UI Interface - Brand new architecture, suitable for SSH Remote environments*
**Keyboard Shortcuts**
- `Ctrl+Enter`: Submit feedback (supports both main keyboard and numpad)
@ -120,7 +136,7 @@ uvx mcp-feedback-enhanced@latest version # Check version
# Interface-specific testing
uvx mcp-feedback-enhanced@latest test --gui # Quick test Qt GUI
uvx mcp-feedback-enhanced@latest test --web # Test Web UI (keeps running)
uvx mcp-feedback-enhanced@latest test --web # Test Web UI (auto continuous running)
# Debug mode
MCP_DEBUG=true uvx mcp-feedback-enhanced@latest test
@ -138,12 +154,12 @@ uv sync
# Method 1: Standard test (recommended)
uv run python -m mcp_feedback_enhanced test
# Method 2: Complete test suite (macOS dev environment)
# Method 2: Complete test suite (macOS and Windows dev environment)
uvx --with-editable . mcp-feedback-enhanced test
# Method 3: Interface-specific testing
uvx --with-editable . mcp-feedback-enhanced test --gui # Quick test Qt GUI
uvx --with-editable . mcp-feedback-enhanced test --web # Test Web UI (keeps running)
uvx --with-editable . mcp-feedback-enhanced test --web # Test Web UI (auto continuous running)
```
**Testing Descriptions**
@ -154,7 +170,16 @@ uvx --with-editable . mcp-feedback-enhanced test --web # Test Web UI (keeps r
## 🆕 Version Highlights
### v2.0.14 (Latest)
### v2.1.0 (Latest Refactored Version)
- 🎨 **Complete Refactoring**: GUI and Web UI adopt modular architecture
- 📁 **Centralized Management**: Reorganized folder structure, improved maintainability
- 🖥️ **Interface Optimization**: Modern design and improved user experience
- 🍎 **macOS Interface Optimization**: Specialized improvements for macOS user experience
- ⚙️ **Feature Enhancement**: New settings options and auto-close page functionality
- 🌐 **Language Switching**: Fixed Web UI content update issues when switching languages
- **About Page**: Added about page with version info, project links, and acknowledgments
### v2.0.14
- ⌨️ Enhanced Shortcuts: Ctrl+Enter supports numpad
- 🖼️ Smart Image Pasting: Ctrl+V directly pastes clipboard images
@ -197,14 +222,3 @@ If you find this useful, please:
### Design Inspiration
**sanshao85** - [mcp-feedback-collector](https://github.com/sanshao85/mcp-feedback-collector)
### Community Support
- **Discord:** [https://discord.gg/Gur2V67](https://discord.gg/Gur2V67)
- **Issues:** [GitHub Issues](https://github.com/Minidoracat/mcp-feedback-enhanced/issues)
## 📄 License
MIT License - See [LICENSE](LICENSE) file for details
---
**🌟 Welcome to Star and share with more developers!**

View File

@ -1,51 +1,67 @@
# Interactive Feedback MCP互动回馈 MCP
# Interactive Feedback MCP交互反馈 MCP
**🌐 语言切换 / Language:** [English](README.md) | [繁體中文](README.zh-TW.md) | **简体中文**
**原作者:** [Fábio Ferreira](https://x.com/fabiomlferreira) | [原始专案](https://github.com/noopstudios/interactive-feedback-mcp) ⭐
**原作者:** [Fábio Ferreira](https://x.com/fabiomlferreira) | [原始项目](https://github.com/noopstudios/interactive-feedback-mcp) ⭐
**分支版本:** [Minidoracat](https://github.com/Minidoracat)
**UI 设计参考:** [sanshao85/mcp-feedback-collector](https://github.com/sanshao85/mcp-feedback-collector)
## 🎯 核心概念
这是一个 [MCP 服器](https://modelcontextprotocol.io/),在 AI 辅助开发工具中实现**人在回路human-in-the-loop**的工作流程。过引导 AI 与用户确认而非进行推测性操作,可将多达 25 次工具调用合并为单次馈导向请求,大幅节省平台成本。
这是一个 [MCP 器](https://modelcontextprotocol.io/),在 AI 辅助开发工具中实现**人在回路human-in-the-loop**的工作流程。过引导 AI 与用户确认而非进行推测性操作,可将多达 25 次工具调用合并为单次馈导向请求,大幅节省平台成本。
**支平台:** [Cursor](https://www.cursor.com) | [Cline](https://cline.bot) | [Windsurf](https://windsurf.com)
**支平台:** [Cursor](https://www.cursor.com) | [Cline](https://cline.bot) | [Windsurf](https://windsurf.com)
### 🔄 工作流程
1. **AI 调用**`mcp-feedback-enhanced`
2. **环境检测** → 自动选择合适
3. **用户互动** → 命令执行、文字回馈、图片上传
4. **回馈传递** → 资讯返回 AI
5. **流程继续** → 根据馈调整或结束
2. **环境检测** → 自动选择合适
3. **用户交互** → 命令执行、文字反馈、图片上传
4. **反馈传递** → 信息返回 AI
5. **流程继续** → 根据馈调整或结束
## 🌟 主要功能
### 🖥️ 双面系统
- **Qt GUI**:本地环境原生体验
- **Web UI**:远端 SSH 环境现代化界面
- **智能切换**:自动检测环境并选择最适
### 🖥️ 双面系统
- **Qt GUI**:本地环境原生体验,模块化重构设计
- **Web UI**:远程 SSH 环境现代化界面,全新架构
- **智能切换**:自动检测环境并选择最适
### 🖼️ 图片支援
- **格式支援**PNG、JPG、JPEG、GIF、BMP、WebP
- **上传方式**:拖拽档案 + 剪贴板粘贴Ctrl+V
### 🎨 全新界面设计v2.1.0
- **模块化架构**GUI 和 Web UI 均采用模块化设计
- **集中管理**:文件夹结构重新组织,维护更容易
- **现代化主题**:改进的视觉设计和用户体验
- **响应式布局**:适应不同屏幕尺寸和窗口大小
### 🖼️ 图片支持
- **格式支持**PNG、JPG、JPEG、GIF、BMP、WebP
- **上传方式**:拖拽文件 + 剪贴板粘贴Ctrl+V
- **自动处理**:智能压缩确保符合 1MB 限制
### 🌏 多语言
- **三语支援**:繁体中文、英文、简体中文
- **智能侦测**:根据系统语言自动选择
- **即时切换**:介面内可直接切换语言
- **三语支持**:简体中文、英文、繁体中文
- **智能测**:根据系统语言自动选择
- **即时切换**面内可直接切换语言
## 🖥️ 面预览
## 🖥️ 面预览
![Qt GUI Interface](docs/images/gui-zh-tw.png)
*Qt GUI 介面 - 本地环境*
### Qt GUI 界面(重构版)
<div align="center">
<img src="docs/images/zh-TW/gui1.png" width="400" alt="Qt GUI 主界面" />
<img src="docs/images/zh-TW/gui2.png" width="400" alt="Qt GUI 设置界面" />
</div>
![Web UI Interface](docs/images/web-zh-tw.png)
*Web UI 介面 - SSH Remote 环境*
*Qt GUI 界面 - 模块化重构,支持本地环境*
**快捷键支援**
- `Ctrl+Enter`:提交回馈(主键盘与数字键盘皆支援)
### Web UI 界面(重构版)
<div align="center">
<img src="docs/images/zh-TW/web1.png" width="400" alt="Web UI 主界面" />
<img src="docs/images/zh-TW/web2.png" width="400" alt="Web UI 设置界面" />
</div>
*Web UI 界面 - 全新架构,适合 SSH Remote 环境*
**快捷键支持**
- `Ctrl+Enter`:提交反馈(主键盘与数字键盘皆支持)
- `Ctrl+V`:直接粘贴剪贴板图片
## 🚀 快速开始
@ -57,7 +73,6 @@ pip install uv
# 快速测试
uvx mcp-feedback-enhanced@latest test
```
### 2. 配置 MCP
@ -75,7 +90,7 @@ uvx mcp-feedback-enhanced@latest test
}
```
**进阶配置**(需要自环境):
**进阶配置**(需要自定义环境):
```json
{
"mcpServers": {
@ -99,16 +114,16 @@ uvx mcp-feedback-enhanced@latest test
```
# MCP Interactive Feedback 规则
1. 在任何流程、任务、对话进行时,无论是询问、回复、或完成阶段性任务,皆必须呼叫 MCP mcp-feedback-enhanced。
2. 每当收到使用者回馈,若回馈内容非空,必须再次呼叫 MCP mcp-feedback-enhanced并根据回馈内容调整行为。
3. 仅当使用者明确表示「结束」或「不再需要互动」时,才可停止呼叫 MCP mcp-feedback-enhanced流程才算结束。
4. 除非收到结束指令,否则所有步骤都必须重复呼叫 MCP mcp-feedback-enhanced。
1. 在任何流程、任务、对话进行时,无论是询问、回复、或完成阶段性任务,皆必须调用 MCP mcp-feedback-enhanced。
2. 每当收到用户反馈,若反馈内容非空,必须再次调用 MCP mcp-feedback-enhanced并根据反馈内容调整行为。
3. 仅当用户明确表示「结束」或「不再需要交互」时,才可停止调用 MCP mcp-feedback-enhanced流程才算结束。
4. 除非收到结束指令,否则所有步骤都必须重复调用 MCP mcp-feedback-enhanced。
```
## ⚙️ 进阶设定
### 环境变
| 变 | 用途 | 值 | 默认 |
### 环境变
| 变 | 用途 | 值 | 默认 |
|------|------|-----|------|
| `FORCE_WEB` | 强制使用 Web UI | `true`/`false` | `false` |
| `MCP_DEBUG` | 调试模式 | `true`/`false` | `false` |
@ -119,9 +134,9 @@ uvx mcp-feedback-enhanced@latest test
# 版本查询
uvx mcp-feedback-enhanced@latest version # 检查版本
# 指定面测试
# 指定面测试
uvx mcp-feedback-enhanced@latest test --gui # 快速测试 Qt GUI
uvx mcp-feedback-enhanced@latest test --web # 测试 Web UI(保持运行)
uvx mcp-feedback-enhanced@latest test --web # 测试 Web UI (自动持续运行)
# 调试模式
MCP_DEBUG=true uvx mcp-feedback-enhanced@latest test
@ -139,12 +154,12 @@ uv sync
# 方式一:标准测试(推荐)
uv run python -m mcp_feedback_enhanced test
# 方式二完整测试套件macOS 开发环境)
# 方式二完整测试套件macOS 和 Windows 通用开发环境)
uvx --with-editable . mcp-feedback-enhanced test
# 方式三:指定面测试
# 方式三:指定面测试
uvx --with-editable . mcp-feedback-enhanced test --gui # 快速测试 Qt GUI
uvx --with-editable . mcp-feedback-enhanced test --web # 测试 Web UI(保持运行)
uvx --with-editable . mcp-feedback-enhanced test --web # 测试 Web UI (自动持续运行)
```
**测试说明**
@ -155,33 +170,42 @@ uvx --with-editable . mcp-feedback-enhanced test --web # 测试 Web UI
## 🆕 版本亮点
### v2.0.14(最新)
- ⌨️ 增强快捷键Ctrl+Enter 支援数字键盘
- 🖼️ 智能图片贴上Ctrl+V 直接贴上剪贴板图片
### v2.1.0(最新重构版)
- 🎨 **全面重构**GUI 和 Web UI 采用模块化架构
- 📁 **集中管理**:重新组织文件夹结构,提升维护性
- 🖥️ **界面优化**:现代化设计和改进的用户体验
- 🍎 **macOS 界面优化**:针对 macOS 用户体验进行专项改进
- ⚙️ **功能增强**:新增设置选项和自动关闭页面功能
- 🌐 **语言切换**:修复 Web UI 语言切换时内容更新问题
- **关于页面**:新增关于页面,包含版本信息、项目链接和致谢内容
### v2.0.14
- ⌨️ 增强快捷键Ctrl+Enter 支持数字键盘
- 🖼️ 智能图片粘贴Ctrl+V 直接粘贴剪贴板图片
### v2.0.9
- 🌏 多语言架构重构,支援动态载入
- 📁 语言档案模组化组织
- 🌏 多语言架构重构,支动态载入
- 📁 语言文件模块化组织
### v2.0.3
- 🛡️ 完全修复中文字符编码问题
- 🔧 解决 JSON 解析错误
### v2.0.0
- ✅ 新增 Web UI 支援远端环境
- ✅ 自动环境检测与面选择
- ✅ 新增 Web UI 支持远程环境
- ✅ 自动环境检测与面选择
- ✅ WebSocket 即时通讯
## 🐛 常见问题
**Q: 出现 "Unexpected token 'D'" 错误**
A: 调试输出干扰。设置 `MCP_DEBUG=false` 或移除该环境变
A: 调试输出干扰。设置 `MCP_DEBUG=false` 或移除该环境变
**Q: 中文字符乱码**
A: 已在 v2.0.3 修复。更新到最新版本:`uvx mcp-feedback-enhanced@latest`
**Q: 图片上传失败**
A: 检查档案大小≤1MB和格式PNG/JPG/GIF/BMP/WebP
A: 检查文件大小≤1MB和格式PNG/JPG/GIF/BMP/WebP
**Q: Web UI 无法启动**
A: 设置 `FORCE_WEB=true` 或检查防火墙设定。
@ -190,10 +214,10 @@ A: 设置 `FORCE_WEB=true` 或检查防火墙设定。
### 🌟 支持原作者
**Fábio Ferreira** - [X @fabiomlferreira](https://x.com/fabiomlferreira)
**原始专案** [noopstudios/interactive-feedback-mcp](https://github.com/noopstudios/interactive-feedback-mcp)
**原始项目** [noopstudios/interactive-feedback-mcp](https://github.com/noopstudios/interactive-feedback-mcp)
如果您觉得有用,请:
- ⭐ [为原专案按星星](https://github.com/noopstudios/interactive-feedback-mcp)
- ⭐ [为原项目按星星](https://github.com/noopstudios/interactive-feedback-mcp)
- 📱 [关注原作者](https://x.com/fabiomlferreira)
### 设计灵感

View File

@ -22,10 +22,16 @@
## 🌟 主要功能
### 🖥️ 雙介面系統
- **Qt GUI**:本地環境原生體驗
- **Web UI**:遠端 SSH 環境現代化界面
- **Qt GUI**:本地環境原生體驗,模組化重構設計
- **Web UI**:遠端 SSH 環境現代化界面,全新架構
- **智能切換**:自動檢測環境並選擇最適介面
### 🎨 全新界面設計v2.1.0
- **模組化架構**GUI 和 Web UI 均採用模組化設計
- **集中管理**:資料夾結構重新組織,維護更容易
- **現代化主題**:改進的視覺設計和用戶體驗
- **響應式布局**:適應不同螢幕尺寸和視窗大小
### 🖼️ 圖片支援
- **格式支援**PNG、JPG、JPEG、GIF、BMP、WebP
- **上傳方式**:拖拽檔案 + 剪貼板粘貼Ctrl+V
@ -38,11 +44,21 @@
## 🖥️ 介面預覽
![Qt GUI Interface](docs/images/gui-zh-tw.png)
*Qt GUI 介面 - 本地環境*
### Qt GUI 介面(重構版)
<div align="center">
<img src="docs/images/zh-TW/gui1.png" width="400" alt="Qt GUI 主介面" />
<img src="docs/images/zh-TW/gui2.png" width="400" alt="Qt GUI 設定介面" />
</div>
![Web UI Interface](docs/images/web-zh-tw.png)
*Web UI 介面 - SSH Remote 環境*
*Qt GUI 介面 - 模組化重構,支援本地環境*
### Web UI 介面(重構版)
<div align="center">
<img src="docs/images/zh-TW/web1.png" width="400" alt="Web UI 主介面" />
<img src="docs/images/zh-TW/web2.png" width="400" alt="Web UI 設定介面" />
</div>
*Web UI 介面 - 全新架構,適合 SSH Remote 環境*
**快捷鍵支援**
- `Ctrl+Enter`:提交回饋(主鍵盤與數字鍵盤皆支援)
@ -138,7 +154,7 @@ uv sync
# 方式一:標準測試(推薦)
uv run python -m mcp_feedback_enhanced test
# 方式二完整測試套件macOS 開發環境)
# 方式二完整測試套件macOS 和 windows 通用開發環境)
uvx --with-editable . mcp-feedback-enhanced test
# 方式三:指定介面測試
@ -154,7 +170,16 @@ uvx --with-editable . mcp-feedback-enhanced test --web # 測試 Web UI (自
## 🆕 版本亮點
### v2.0.14(最新)
### v2.1.0(最新重構版)
- 🎨 **全面重構**GUI 和 Web UI 採用模組化架構
- 📁 **集中管理**:重新組織資料夾結構,提升維護性
- 🖥️ **界面優化**:現代化設計和改進的用戶體驗
- 🍎 **macOS 介面優化**:針對 macOS 用戶體驗進行專項改進
- ⚙️ **功能增強**:新增設定選項和自動關閉頁面功能
- 🌐 **語言切換**:修復 Web UI 語言切換時內容更新問題
- **About 頁面**:新增關於頁面,包含版本資訊、專案連結和致謝內容
### v2.0.14
- ⌨️ 增強快捷鍵Ctrl+Enter 支援數字鍵盤
- 🖼️ 智能圖片貼上Ctrl+V 直接貼上剪貼板圖片

BIN
docs/images/en/gui1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

BIN
docs/images/en/gui2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

BIN
docs/images/en/web1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

BIN
docs/images/en/web2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

BIN
docs/images/zh-TW/gui1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

BIN
docs/images/zh-TW/gui2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

BIN
docs/images/zh-TW/web1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

BIN
docs/images/zh-TW/web2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB