本次提交主要集成了 MCP 服务器,为系统增加了用户提示词优化工具,并通过优化部署流程,提升了整体易用性。
具体变更内容包括:
* **功能增强:**
* 集成 MCP 服务器,提供用户和系统提示词优化工具,支持 stdio 和 HTTP 两种传输方式,并集成了 Claude Desktop。
* 实现基于会话的 HTTP 传输,允许多客户端连接,并为每个会话创建独立的 MCP 服务器实例,确保会话间的隔离性。
* **部署优化:**
* 将 MCP 服务器端口变更为与 Web 界面共享 80 端口,通过路径区分,简化了 Docker 部署配置,降低了部署复杂度。
* 优化 Docker 部署流程,使用 Supervisor 进行进程管理,并改进模板参数(使用枚举类型 + 默认值),同时提供了包含 MCP 服务器使用说明的 Docker 部署文档。
* **代码优化与重构:**
* 优化模型选择逻辑,提高模型选择的准确性。
* 优化日志记录功能,支持更灵活的日志级别设置,并添加了详细的错误提示和调试信息,方便问题排查。
* 重构代码,分离构建和启动入口,优化环境变量加载和模型初始化逻辑,提高了代码的可维护性和可扩展性,并解决了构建副作用问题。
* **文档更新:**
* 更新工具描述和使用说明,提供了用户和系统提示词工具的具体示例,并补充了迭代提示词工具的改进需求描述和使用场景。
* 更新 Docker 部署方案,包含了 `docker-compose.yml`、`Dockerfile` 和 `env.local.example` 配置示例,并更新了 README 文档以明确连接方式。
* 更新 `nginx.conf`,使用环境变量 `NGINX_PORT`,修改 `start-services.sh`,增加 nginx 配置处理,更新 `supervisord.conf`,调整 MCP 服务器启动方式,优化 `Dockerfile`,安装额外依赖并调整工作目录,调整环境变量加载机制,使用 `preload-env.cjs`。
* **其他:**
* 提供快速开始指南、环境变量配置和问题排除等文档,更新了相关文档链接和获取帮助指引,并完成了基础测试用例和开发/设计文档。
本次更新旨在提升用户在提示词优化方面的能力,并简化部署流程,提高系统的整体可用性和可维护性。
项目文档索引
欢迎来到Prompt Optimizer项目文档!本文档采用分级分类的组织方式,便于不同角色的用户快速找到所需信息。
📚 文档分类
👥 用户文档
面向最终用户的使用指南、部署说明和常见问题
- 桌面版用户手册
- Web版使用指南
- 部署指南(Vercel等)
- 常见问题解答
👨💻 开发者文档
面向开发者的技术文档、API参考和故障排查
- 技术开发指南
- 项目结构说明
- API文档
- 架构设计
- 故障排查清单
📋 项目管理文档
面向项目管理的需求文档、状态跟踪和规划
- 产品需求文档
- 项目状态和进度
- 版本管理策略
- 功能规划
📦 开发过程归档
按功能点归档的开发记录,用于跟踪和排错
- 101-singleton-refactor - 单例模式重构 ✅
- 102-web-architecture-refactor - Web架构重构 ✅
- 103-desktop-architecture - 桌面端架构 🔄
- 104-test-panel-refactor - 测试面板重构 📋
- 105-output-display-v2 - 输出显示v2 📋
- 106-template-management - 模板管理功能 🔄
🛠️ 开发工作区
当前开发阶段的临时文档和开发笔记
- 开发笔记和临时记录
- 待办事项
- 实验性设计
🚀 快速导航
我是用户
我是开发者
我是项目管理者
📖 重要文档
核心文档
专项文档
📋 使用指南
新成员入职
日常开发
项目管理
🔄 文档维护
维护原则
- 分类明确:按目标受众和用途分类存放
- 及时更新:代码变更时同步更新相关文档
- 定期整理:定期清理过期内容,整理工作区文档
- 交叉引用:在相关文档间建立引用关系
文档规范
- 使用Markdown格式
- 统一的标题层级结构
- 代码示例使用语法高亮
- 文档末尾标注更新时间
归档流程
- 新功能开发:在archives/中创建新的功能点目录(从107开始编号)
- 重要经验:及时从workspace/转移到archives/对应功能点
- 通用指南:从临时记录整理为正式的developer/文档
文档重构完成时间:2025-07-01 下一次整理计划:根据开发进度定期更新