Skip to main content

A modern Web-based MCP server for interactive user feedback collection - perfect for SSH environments

Project description

🎯 MCP反馈通道 (MCP Feedback Pipe)

Version Python License SSH Compatible Markdown Mermaid

一个基于Flask的现代化Web界面反馈收集工具,专为MCP (Model Context Protocol) 环境设计。从GUI架构完全重构为Web架构,完美支持SSH远程环境和Cursor等现代开发工具。支持Markdown渲染、Mermaid图表、代码高亮等丰富的内容展示功能。


🆕 最新更新 (v3.0.1)

功能验证与优化

  • 🔧 suggest参数验证: 确认 collect_feedback 工具的 suggest 参数正确使用数组类型 List[str]
  • 🎯 参数处理优化: 验证从MCP调用到前端显示的完整数据流,无不必要的JSON转换
  • 🌐 前端界面增强: 建议选项正确显示,支持点击直接提交或复制到输入框
  • 📱 用户体验改进: 界面布局优化,响应式设计完善
  • 🎨 界面重构: 紧凑化布局、动态大小调整、图片上传体验优化
  • 📝 内容渲染: Markdown语法支持、Mermaid图表渲染、代码语法高亮

🛠️ 技术改进

  • ✅ 参数类型优化: suggest 参数使用标准数组格式
  • 🧪 功能测试: 通过实际测试验证建议选项功能正常
  • 📋 代码质量: 确保参数处理符合最佳实践

🚀 快速开始

⭐ 推荐:uvx一键安装

# ✅ PyPI正式发布,零配置一键运行
uvx mcp-feedback-pipe

🎉 发布状态: 已正式发布到PyPI!使用全新名称mcp-feedback-pipe,无冲突,即装即用

📦 传统方式安装

# 克隆项目
git clone https://github.com/ElemTran/mcp-feedback-pipe.git
cd mcp-feedback-pipe

# 创建虚拟环境
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# 安装依赖
pip install -r requirements.txt

# 启动服务
python scripts/start_server.py

🎯 核心特性

✨ 用户体验

  • 🌐 现代Web界面: 基于Flask + HTML5的响应式设计
  • 📱 多设备支持: 手机、平板、电脑完美适配
  • 🎨 优雅交互: 实时反馈、动画效果、直观操作
  • 📝 丰富内容: Markdown渲染、Mermaid图表、代码高亮

🔧 技术架构

  • 🏗️ 模块化设计: 8个核心模块,关注点分离
  • 🧪 完整测试: 43个测试用例,65%代码覆盖率
  • 📊 实时监控: 服务状态、端口管理、进程监控

🌍 环境兼容

  • 🔗 SSH远程支持: 完美支持SSH端口转发
  • 🎯 Cursor集成: 无缝集成Cursor MCP工具链
  • ⚡ uvx零配置: 一键安装,即开即用

🛠️ Cursor MCP配置

⭐ 推荐配置 (PyPI版本)

{
  "mcpServers": {
    "mcp-feedback-pipe": {
      "command": "uvx",
      "args": ["mcp-feedback-pipe"],
      "env": {
        "PYTHONIOENCODING": "utf-8",
        "MCP_DIALOG_TIMEOUT": "600",
        "MCP_USE_WEB": "true"
      }
    }
  }
}

✅ 已发布: 直接使用PyPI版本,自动获取最新更新

备选配置 (本地开发)

{
  "mcpServers": {
    "mcp-feedback-pipe": {
      "command": "/path/to/mcp-feedback-pipe/.venv/bin/python",
      "args": ["-m", "mcp_feedback_pipe.server"],
      "env": {
        "PYTHONPATH": "/path/to/mcp-feedback-pipe/src",
        "MCP_USE_WEB": "true"
      }
    }
  }
}

🔗 SSH环境部署

端口转发配置

# 本地转发(推荐)
ssh -L 5000:localhost:5000 username@your-server-ip

# 使用VS Code SSH扩展会自动处理端口转发

🎯 在Cursor中的使用配置

在Cursor的自定义指令中可以这样配置:

"Whenever you want to ask a question, always call the MCP.

Whenever you're about to complete a user request, call the MCP instead of simply ending the process. Keep calling MCP until the user's feedback is empty, then end the request. mcp-feedback-pipe.collect_feedback"

📚 可用工具

🎯 核心功能

  • collect_feedback: 启动Web界面收集用户反馈
    • work_summary: AI工作汇报内容
    • timeout_seconds: 超时时间(默认300秒)
    • suggest: 建议选项列表,格式如:["选项1", "选项2", "选项3"]已验证
  • pick_image: 图片选择和上传功能
  • get_image_info_tool: 获取图片详细信息

💡 使用示例

# 在Cursor中调用collect_feedback工具
# 1. 基础反馈收集
collect_feedback(work_summary="任务完成情况汇报")

# 2. 带建议选项的反馈收集 ✨新功能验证
collect_feedback(
    work_summary="功能开发完成,请提供反馈",
    suggest=["功能正常", "需要优化", "有问题", "建议修改"]
)

# 3. 自定义超时时间
collect_feedback(
    work_summary="长时间任务完成",
    timeout_seconds=600,
    suggest=["满意", "需要调整", "继续优化"]
)

🏗️ 项目架构

📁 目录结构

mcp-feedback-pipe/
├── src/mcp_feedback_pipe/         # 核心源代码
│   ├── server.py                  # MCP服务器
│   ├── web_app.py                # Flask Web应用
│   ├── server_manager.py         # 服务管理器
│   └── templates/                # Web模板
├── scripts/                      # 实用脚本
├── tests/                        # 测试套件
└── docs/                         # 完整文档

🧪 质量保证

  • 单元测试: 32个测试用例
  • 集成测试: 11个测试用例
  • 代码覆盖率: 65%
  • 代码规范: 每个文件<250行

📖 文档资源

📋 配置指南

🏛️ 技术文档


🎯 版本历史

v3.0.1 (当前版本)

  • ✅ suggest参数验证: 确认数组类型参数处理正确
  • 🎯 功能测试完善: 实际验证建议选项功能
  • 🌐 界面优化: 前端交互体验改进
  • 🎨 界面重构: 紧凑化布局、动态调整、上传体验优化
  • 📝 内容渲染: Markdown语法、Mermaid图表、代码高亮支持
  • 📋 文档更新: 完善使用示例和参数说明

v3.0.0 (重大版本)

  • 🏗️ 架构重构: GUI → Web,完全重写
  • 🌐 现代化界面: Flask + HTML5响应式设计
  • 🔗 SSH完美支持: 无缝集成SSH远程环境
  • ⚡ uvx零配置: 一键安装即开即用
  • 🧪 完整测试: 43个测试用例,质量保证

v2.x (已废弃)

  • 基于tkinter的GUI版本
  • SSH环境兼容性问题
  • 已完全替换为Web版本

🤝 贡献指南

🛠️ 开发环境

# 开发者安装
git clone https://github.com/ElemTran/mcp-feedback-pipe.git
cd mcp-feedback-pipe
python -m venv .venv
source .venv/bin/activate
pip install -e .

# 运行测试
pytest

# 代码格式化
black src/ tests/

📝 提交规范

  • 🐛 fix: 修复bug
  • feat: 新功能
  • 📚 docs: 文档更新
  • 🧪 test: 测试相关
  • 🔧 refactor: 代码重构

📄 许可证

MIT License - 详见 LICENSE 文件


🙏 致谢

感谢所有贡献者和社区支持!

让AI与用户的交互更高效直观! 🎯

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_feedback_pipe-3.0.5.tar.gz (94.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_feedback_pipe-3.0.5-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file mcp_feedback_pipe-3.0.5.tar.gz.

File metadata

  • Download URL: mcp_feedback_pipe-3.0.5.tar.gz
  • Upload date:
  • Size: 94.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.8

File hashes

Hashes for mcp_feedback_pipe-3.0.5.tar.gz
Algorithm Hash digest
SHA256 7002bbbac0aa359b4cf7a07b0ef725c0c38fad0803e2cc9c5fdcd8d0cdefa8d1
MD5 6385350a2f6a4be2a0cffcd14c41d83a
BLAKE2b-256 60feccce0e91b692f779aacd003b1412c6dadeb33af371ad9bd06286774d95e7

See more details on using hashes here.

File details

Details for the file mcp_feedback_pipe-3.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_feedback_pipe-3.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7f282ac43e63a32678d2550f70df3d5ec086670f59a6a193d436d3f2f44e500b
MD5 572869bab8520db8a774c7247fe04ba1
BLAKE2b-256 92b23fcc8497f0fb5a7ab311cdd7b8b82058a45de3d7122d2ff0166006da3ae4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page